From f03c2686d29108d41cb3e1c4bd04b7416d0ef8ab Mon Sep 17 00:00:00 2001 From: "api-clients-generation-pipeline[bot]" <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com> Date: Wed, 4 Sep 2024 20:36:11 +0000 Subject: [PATCH] Add new synthetics HTTP javascript assertion (#24490) Co-authored-by: ci.datadog-api-spec --- .apigentools-info | 8 +- content/en/api/v1/synthetics/examples.json | 38 +- ...st.CreateSyntheticsAPITest_1487281163.json | 4 + ...st.CreateSyntheticsAPITest_1987645492.json | 4 + data/api/v1/full_spec.yaml | 22 + data/api/v1/full_spec_deref.json | 2373 ++++++++++++----- static/resources/json/full_spec_v1.json | 2373 ++++++++++++----- 7 files changed, 3503 insertions(+), 1319 deletions(-) diff --git a/.apigentools-info b/.apigentools-info index 41c03c4397093..381c607c86029 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2024-09-04 15:25:09.981283", - "spec_repo_commit": "fe4f848e" + "regenerated": "2024-09-04 17:13:40.915305", + "spec_repo_commit": "8e0507d2" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2024-09-04 15:25:18.207800", - "spec_repo_commit": "fe4f848e" + "regenerated": "2024-09-04 17:13:49.040434", + "spec_repo_commit": "8e0507d2" } } } \ 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 efd7daabe219d..d6da7d80b7ab7 100644 --- a/content/en/api/v1/synthetics/examples.json +++ b/content/en/api/v1/synthetics/examples.json @@ -517,7 +517,7 @@ } ] }, - "html": "
\n
\n
\n
\n

tests

\n
\n

[object]

\n

Array of Synthetic tests configuration.

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

config

\n
\n

object

\n

Configuration object for a Synthetic 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
\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

\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

string

\n

Port to use when performing the test.

\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

variables

\n
\n

[object]

\n

Browser tests only - array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

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

creator

\n
\n

object

\n

Object describing the creator of the shared element.

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

email

\n
\n

string

\n

Email of the creator.

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

handle

\n
\n

string

\n

Handle of the creator.

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

name

\n
\n

string

\n

Name of the creator.

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

locations

\n
\n

[string]

\n

Array of locations used to run the test.

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

message

\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

\n
\n

string

\n

Name of the test.

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

options

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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 test public ID.

\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

steps

\n
\n

[object]

\n

For browser test, the steps of the test.

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

allowFailure

\n
\n

boolean

\n

A boolean set to allow this step to fail.

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

isCritical

\n
\n

boolean

\n

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

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

name

\n
\n

string

\n

The name of the step.

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

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

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

params

\n
\n

object

\n

The parameters of the step.

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

timeout

\n
\n

int64

\n

The time before declaring a step failed.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

\n
\n \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

\n
\n

enum

\n

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

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

tests

\n
\n

[object]

\n

Array of Synthetic tests configuration.

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

config

\n
\n

object

\n

Configuration object for a Synthetic 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

\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

string

\n

Port to use when performing the test.

\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

variables

\n
\n

[object]

\n

Browser tests only - array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

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

creator

\n
\n

object

\n

Object describing the creator of the shared element.

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

email

\n
\n

string

\n

Email of the creator.

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

handle

\n
\n

string

\n

Handle of the creator.

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

name

\n
\n

string

\n

Name of the creator.

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

locations

\n
\n

[string]

\n

Array of locations used to run the test.

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

message

\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

\n
\n

string

\n

Name of the test.

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

options

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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 test public ID.

\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

steps

\n
\n

[object]

\n

For browser test, the steps of the test.

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

allowFailure

\n
\n

boolean

\n

A boolean set to allow this step to fail.

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

isCritical

\n
\n

boolean

\n

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

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

name

\n
\n

string

\n

The name of the step.

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

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

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

params

\n
\n

object

\n

The parameters of the step.

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

timeout

\n
\n

int64

\n

The time before declaring a step failed.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

\n
\n \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

\n
\n

enum

\n

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

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -728,7 +728,7 @@ "tags": [], "type": "string" }, - "html": "
\n
\n
\n
\n

config

\n
\n

object

\n

Configuration object for a Synthetic 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
\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

\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

string

\n

Port to use when performing the test.

\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

variables

\n
\n

[object]

\n

Browser tests only - array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

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

creator

\n
\n

object

\n

Object describing the creator of the shared element.

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

email

\n
\n

string

\n

Email of the creator.

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

handle

\n
\n

string

\n

Handle of the creator.

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

name

\n
\n

string

\n

Name of the creator.

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

locations

\n
\n

[string]

\n

Array of locations used to run the test.

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

message

\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

\n
\n

string

\n

Name of the test.

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

options

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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 test public ID.

\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

steps

\n
\n

[object]

\n

For browser test, the steps of the test.

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

allowFailure

\n
\n

boolean

\n

A boolean set to allow this step to fail.

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

isCritical

\n
\n

boolean

\n

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

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

name

\n
\n

string

\n

The name of the step.

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

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

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

params

\n
\n

object

\n

The parameters of the step.

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

timeout

\n
\n

int64

\n

The time before declaring a step failed.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

\n
\n \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

\n
\n

enum

\n

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

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

config

\n
\n

object

\n

Configuration object for a Synthetic 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

\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

string

\n

Port to use when performing the test.

\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

variables

\n
\n

[object]

\n

Browser tests only - array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

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

creator

\n
\n

object

\n

Object describing the creator of the shared element.

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

email

\n
\n

string

\n

Email of the creator.

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

handle

\n
\n

string

\n

Handle of the creator.

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

name

\n
\n

string

\n

Name of the creator.

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

locations

\n
\n

[string]

\n

Array of locations used to run the test.

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

message

\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

\n
\n

string

\n

Name of the test.

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

options

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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 test public ID.

\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

steps

\n
\n

[object]

\n

For browser test, the steps of the test.

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

allowFailure

\n
\n

boolean

\n

A boolean set to allow this step to fail.

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

isCritical

\n
\n

boolean

\n

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

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

name

\n
\n

string

\n

The name of the step.

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

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

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

params

\n
\n

object

\n

The parameters of the step.

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

timeout

\n
\n

int64

\n

The time before declaring a step failed.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

\n
\n \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

\n
\n

enum

\n

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

\n
\n \n
\n
" }, "400": { "json": { @@ -958,7 +958,7 @@ "tags": [], "type": "string" }, - "html": "
\n
\n
\n
\n

config

\n
\n

object

\n

Configuration object for a Synthetic 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
\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

\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

string

\n

Port to use when performing the test.

\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

variables

\n
\n

[object]

\n

Browser tests only - array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

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

creator

\n
\n

object

\n

Object describing the creator of the shared element.

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

email

\n
\n

string

\n

Email of the creator.

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

handle

\n
\n

string

\n

Handle of the creator.

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

name

\n
\n

string

\n

Name of the creator.

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

locations

\n
\n

[string]

\n

Array of locations used to run the test.

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

message

\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

\n
\n

string

\n

Name of the test.

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

options

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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 test public ID.

\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

steps

\n
\n

[object]

\n

For browser test, the steps of the test.

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

allowFailure

\n
\n

boolean

\n

A boolean set to allow this step to fail.

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

isCritical

\n
\n

boolean

\n

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

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

name

\n
\n

string

\n

The name of the step.

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

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

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

params

\n
\n

object

\n

The parameters of the step.

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

timeout

\n
\n

int64

\n

The time before declaring a step failed.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

\n
\n \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

\n
\n

enum

\n

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

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

config

\n
\n

object

\n

Configuration object for a Synthetic 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

\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

string

\n

Port to use when performing the test.

\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

variables

\n
\n

[object]

\n

Browser tests only - array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

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

creator

\n
\n

object

\n

Object describing the creator of the shared element.

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

email

\n
\n

string

\n

Email of the creator.

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

handle

\n
\n

string

\n

Handle of the creator.

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

name

\n
\n

string

\n

Name of the creator.

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

locations

\n
\n

[string]

\n

Array of locations used to run the test.

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

message

\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

\n
\n

string

\n

Name of the test.

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

options

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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 test public ID.

\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

steps

\n
\n

[object]

\n

For browser test, the steps of the test.

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

allowFailure

\n
\n

boolean

\n

A boolean set to allow this step to fail.

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

isCritical

\n
\n

boolean

\n

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

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

name

\n
\n

string

\n

The name of the step.

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

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

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

params

\n
\n

object

\n

The parameters of the step.

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

timeout

\n
\n

int64

\n

The time before declaring a step failed.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

\n
\n \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

\n
\n

enum

\n

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

\n
\n \n
\n
" } }, "CreateSyntheticsAPITest": { @@ -1111,7 +1111,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
\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

\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

string

\n

Port to use when performing the test.

\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
\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

string

\n

Port to use when performing the test.

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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

\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

string

\n

Port to use when performing the test.

\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

string

\n

Port to use when performing the test.

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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": { @@ -1318,7 +1318,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
\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

\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

string

\n

Port to use when performing the test.

\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
\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

string

\n

Port to use when performing the test.

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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

\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

string

\n

Port to use when performing the test.

\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

string

\n

Port to use when performing the test.

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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": { @@ -1471,7 +1471,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
\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

\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

string

\n

Port to use when performing the test.

\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
\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

string

\n

Port to use when performing the test.

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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

\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

string

\n

Port to use when performing the test.

\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

string

\n

Port to use when performing the test.

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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": { @@ -1654,7 +1654,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
\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

\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

string

\n

Port to use when performing the test.

\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
\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

string

\n

Port to use when performing the test.

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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

\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

string

\n

Port to use when performing the test.

\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

string

\n

Port to use when performing the test.

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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": { @@ -1861,7 +1861,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
\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

\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

string

\n

Port to use when performing the test.

\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
\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

string

\n

Port to use when performing the test.

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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

\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

string

\n

Port to use when performing the test.

\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

string

\n

Port to use when performing the test.

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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": { @@ -2039,7 +2039,7 @@ ], "type": "browser" }, - "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic browser test.

\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
\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

\n
\n \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

string

\n

Port to use when performing the test.

\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

setCookie

\n
\n

string

\n

Cookies to be used for the request, using the Set-Cookie syntax.

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

variables

\n
\n

[object]

\n

Array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

\n
\n \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. Message can either be text or an empty string.

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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 of 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

steps

\n
\n

[object]

\n

Array of steps for the test.

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

allowFailure

\n
\n

boolean

\n

A boolean set to allow this step to fail.

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

isCritical

\n
\n

boolean

\n

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

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

name

\n
\n

string

\n

The name of the step.

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

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

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

params

\n
\n

object

\n

The parameters of the step.

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

timeout

\n
\n

int64

\n

The time before declaring a step failed.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

\n
\n \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, browser. \nAllowed enum values: browser

default: browser

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

config [required]

\n
\n

object

\n

Configuration object for a Synthetic browser test.

\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

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

\n
\n \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

string

\n

Port to use when performing the test.

\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

setCookie

\n
\n

string

\n

Cookies to be used for the request, using the Set-Cookie syntax.

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

variables

\n
\n

[object]

\n

Array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

\n
\n \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. Message can either be text or an empty string.

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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 of 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

steps

\n
\n

[object]

\n

Array of steps for the test.

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

allowFailure

\n
\n

boolean

\n

A boolean set to allow this step to fail.

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

isCritical

\n
\n

boolean

\n

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

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

name

\n
\n

string

\n

The name of the step.

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

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

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

params

\n
\n

object

\n

The parameters of the step.

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

timeout

\n
\n

int64

\n

The time before declaring a step failed.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

\n
\n \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, browser. \nAllowed enum values: browser

default: browser

\n
\n \n
\n
" }, "400": { "json": { @@ -2280,7 +2280,7 @@ ], "type": "browser" }, - "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic browser test.

\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
\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

\n
\n \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

string

\n

Port to use when performing the test.

\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

setCookie

\n
\n

string

\n

Cookies to be used for the request, using the Set-Cookie syntax.

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

variables

\n
\n

[object]

\n

Array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

\n
\n \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. Message can either be text or an empty string.

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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 of 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

steps

\n
\n

[object]

\n

Array of steps for the test.

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

allowFailure

\n
\n

boolean

\n

A boolean set to allow this step to fail.

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

isCritical

\n
\n

boolean

\n

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

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

name

\n
\n

string

\n

The name of the step.

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

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

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

params

\n
\n

object

\n

The parameters of the step.

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

timeout

\n
\n

int64

\n

The time before declaring a step failed.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

\n
\n \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, browser. \nAllowed enum values: browser

default: browser

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

config [required]

\n
\n

object

\n

Configuration object for a Synthetic browser test.

\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

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

\n
\n \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

string

\n

Port to use when performing the test.

\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

setCookie

\n
\n

string

\n

Cookies to be used for the request, using the Set-Cookie syntax.

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

variables

\n
\n

[object]

\n

Array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

\n
\n \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. Message can either be text or an empty string.

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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 of 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

steps

\n
\n

[object]

\n

Array of steps for the test.

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

allowFailure

\n
\n

boolean

\n

A boolean set to allow this step to fail.

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

isCritical

\n
\n

boolean

\n

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

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

name

\n
\n

string

\n

The name of the step.

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

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

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

params

\n
\n

object

\n

The parameters of the step.

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

timeout

\n
\n

int64

\n

The time before declaring a step failed.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

\n
\n \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, browser. \nAllowed enum values: browser

default: browser

\n
\n \n
\n
" } }, "GetBrowserTest": { @@ -2458,7 +2458,7 @@ ], "type": "browser" }, - "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic browser test.

\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
\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

\n
\n \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

string

\n

Port to use when performing the test.

\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

setCookie

\n
\n

string

\n

Cookies to be used for the request, using the Set-Cookie syntax.

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

variables

\n
\n

[object]

\n

Array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

\n
\n \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. Message can either be text or an empty string.

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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 of 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

steps

\n
\n

[object]

\n

Array of steps for the test.

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

allowFailure

\n
\n

boolean

\n

A boolean set to allow this step to fail.

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

isCritical

\n
\n

boolean

\n

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

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

name

\n
\n

string

\n

The name of the step.

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

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

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

params

\n
\n

object

\n

The parameters of the step.

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

timeout

\n
\n

int64

\n

The time before declaring a step failed.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

\n
\n \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, browser. \nAllowed enum values: browser

default: browser

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

config [required]

\n
\n

object

\n

Configuration object for a Synthetic browser test.

\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

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

\n
\n \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

string

\n

Port to use when performing the test.

\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

setCookie

\n
\n

string

\n

Cookies to be used for the request, using the Set-Cookie syntax.

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

variables

\n
\n

[object]

\n

Array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

\n
\n \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. Message can either be text or an empty string.

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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 of 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

steps

\n
\n

[object]

\n

Array of steps for the test.

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

allowFailure

\n
\n

boolean

\n

A boolean set to allow this step to fail.

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

isCritical

\n
\n

boolean

\n

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

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

name

\n
\n

string

\n

The name of the step.

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

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

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

params

\n
\n

object

\n

The parameters of the step.

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

timeout

\n
\n

int64

\n

The time before declaring a step failed.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

\n
\n \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, browser. \nAllowed enum values: browser

default: browser

\n
\n \n
\n
" }, "403": { "json": { @@ -2666,7 +2666,7 @@ ], "type": "browser" }, - "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic browser test.

\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
\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

\n
\n \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

string

\n

Port to use when performing the test.

\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

setCookie

\n
\n

string

\n

Cookies to be used for the request, using the Set-Cookie syntax.

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

variables

\n
\n

[object]

\n

Array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

\n
\n \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. Message can either be text or an empty string.

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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 of 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

steps

\n
\n

[object]

\n

Array of steps for the test.

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

allowFailure

\n
\n

boolean

\n

A boolean set to allow this step to fail.

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

isCritical

\n
\n

boolean

\n

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

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

name

\n
\n

string

\n

The name of the step.

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

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

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

params

\n
\n

object

\n

The parameters of the step.

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

timeout

\n
\n

int64

\n

The time before declaring a step failed.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

\n
\n \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, browser. \nAllowed enum values: browser

default: browser

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

config [required]

\n
\n

object

\n

Configuration object for a Synthetic browser test.

\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

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

\n
\n \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

string

\n

Port to use when performing the test.

\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

setCookie

\n
\n

string

\n

Cookies to be used for the request, using the Set-Cookie syntax.

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

variables

\n
\n

[object]

\n

Array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

\n
\n \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. Message can either be text or an empty string.

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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 of 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

steps

\n
\n

[object]

\n

Array of steps for the test.

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

allowFailure

\n
\n

boolean

\n

A boolean set to allow this step to fail.

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

isCritical

\n
\n

boolean

\n

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

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

name

\n
\n

string

\n

The name of the step.

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

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

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

params

\n
\n

object

\n

The parameters of the step.

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

timeout

\n
\n

int64

\n

The time before declaring a step failed.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

\n
\n \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, browser. \nAllowed enum values: browser

default: browser

\n
\n \n
\n
" }, "400": { "json": { @@ -2907,7 +2907,7 @@ ], "type": "browser" }, - "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic browser test.

\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
\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

\n
\n \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

string

\n

Port to use when performing the test.

\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

setCookie

\n
\n

string

\n

Cookies to be used for the request, using the Set-Cookie syntax.

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

variables

\n
\n

[object]

\n

Array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

\n
\n \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. Message can either be text or an empty string.

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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 of 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

steps

\n
\n

[object]

\n

Array of steps for the test.

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

allowFailure

\n
\n

boolean

\n

A boolean set to allow this step to fail.

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

isCritical

\n
\n

boolean

\n

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

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

name

\n
\n

string

\n

The name of the step.

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

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

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

params

\n
\n

object

\n

The parameters of the step.

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

timeout

\n
\n

int64

\n

The time before declaring a step failed.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

\n
\n \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, browser. \nAllowed enum values: browser

default: browser

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

config [required]

\n
\n

object

\n

Configuration object for a Synthetic browser test.

\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

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

\n
\n \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

string

\n

Port to use when performing the test.

\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

setCookie

\n
\n

string

\n

Cookies to be used for the request, using the Set-Cookie syntax.

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

variables

\n
\n

[object]

\n

Array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

\n
\n \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. Message can either be text or an empty string.

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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 of 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

steps

\n
\n

[object]

\n

Array of steps for the test.

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

allowFailure

\n
\n

boolean

\n

A boolean set to allow this step to fail.

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

isCritical

\n
\n

boolean

\n

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

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

name

\n
\n

string

\n

The name of the step.

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

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

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

params

\n
\n

object

\n

The parameters of the step.

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

timeout

\n
\n

int64

\n

The time before declaring a step failed.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

\n
\n \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, browser. \nAllowed enum values: browser

default: browser

\n
\n \n
\n
" } }, "GetBrowserTestLatestResults": { @@ -3139,7 +3139,7 @@ "result_id": "string", "status": "integer" }, - "html": "
\n
\n
\n
\n

check

\n
\n

object

\n

Object describing the browser test configuration.

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

config [required]

\n
\n

object

\n

Configuration object for a Synthetic 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
\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

\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

string

\n

Port to use when performing the test.

\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

variables

\n
\n

[object]

\n

Browser tests only - array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

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

check_time

\n
\n

double

\n

When the browser test was conducted.

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

check_version

\n
\n

int64

\n

Version of the browser test used.

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

probe_dc

\n
\n

string

\n

Location from which the browser test was performed.

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

result

\n
\n

object

\n

Object containing results for your Synthetic browser test.

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

browserType

\n
\n

string

\n

Type of browser device used for the browser test.

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

browserVersion

\n
\n

string

\n

Browser version used for the browser test.

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

device

\n
\n

object

\n

Object describing the device used to perform the Synthetic test.

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

height [required]

\n
\n

int64

\n

Screen height of the device.

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

id [required]

\n
\n

enum

\n

The device ID. \nAllowed enum values: laptop_large,tablet,mobile_small,chrome.laptop_large,chrome.tablet,chrome.mobile_small,firefox.laptop_large,firefox.tablet,firefox.mobile_small,edge.laptop_large,edge.tablet,edge.mobile_small

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

isMobile

\n
\n

boolean

\n

Whether or not the device is a mobile.

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

name [required]

\n
\n

string

\n

The device name.

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

width [required]

\n
\n

int64

\n

Screen width of the device.

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

duration

\n
\n

double

\n

Global duration in second of the browser test.

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

error

\n
\n

string

\n

Error returned for the browser test.

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

failure

\n
\n

object

\n

The browser test failure details.

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

code

\n
\n

enum

\n

Error code that can be returned by a Synthetic test. \nAllowed enum values: API_REQUEST_FAILURE,ASSERTION_FAILURE,DOWNLOAD_FILE_TOO_LARGE,ELEMENT_NOT_INTERACTABLE,EMAIL_VARIABLE_NOT_DEFINED,EVALUATE_JAVASCRIPT,EVALUATE_JAVASCRIPT_CONTEXT,EXTRACT_VARIABLE,FORBIDDEN_URL,FRAME_DETACHED,INCONSISTENCIES,INTERNAL_ERROR,INVALID_TYPE_TEXT_DELAY,INVALID_URL,INVALID_VARIABLE_PATTERN,INVISIBLE_ELEMENT,LOCATE_ELEMENT,NAVIGATE_TO_LINK,OPEN_URL,PRESS_KEY,SERVER_CERTIFICATE,SELECT_OPTION,STEP_TIMEOUT,SUB_TEST_NOT_PASSED,TEST_TIMEOUT,TOO_MANY_HTTP_REQUESTS,UNAVAILABLE_BROWSER,UNKNOWN,UNSUPPORTED_AUTH_SCHEMA,UPLOAD_FILES_ELEMENT_TYPE,UPLOAD_FILES_DIALOG,UPLOAD_FILES_DYNAMIC_ELEMENT,UPLOAD_FILES_NAME

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

message

\n
\n

string

\n

The browser test error message.

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

passed

\n
\n

boolean

\n

Whether or not the browser test was conducted.

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

receivedEmailCount

\n
\n

int64

\n

The amount of email received during the browser test.

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

startUrl

\n
\n

string

\n

Starting URL for the browser test.

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

stepDetails

\n
\n

[object]

\n

Array containing the different browser test steps.

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

browserErrors

\n
\n

[object]

\n

Array of errors collected for a browser test.

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

description [required]

\n
\n

string

\n

Description of the error.

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

name [required]

\n
\n

string

\n

Name of the error.

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

status

\n
\n

int64

\n

Status Code of the error.

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

type [required]

\n
\n

enum

\n

Error type returned by a browser test. \nAllowed enum values: network,js

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

checkType

\n
\n

enum

\n

Type of assertion to apply in an API test. \nAllowed enum values: equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty

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

description

\n
\n

string

\n

Description of the test.

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

duration

\n
\n

double

\n

Total duration in millisecond of the test.

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

error

\n
\n

string

\n

Error returned by the test.

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

playingTab

\n
\n

enum

\n

Navigate between different tabs for your browser test. \nAllowed enum values: -1,0,1,2,3

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

screenshotBucketKey

\n
\n

boolean

\n

Whether or not screenshots where collected by the test.

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

skipped

\n
\n

boolean

\n

Whether or not to skip this step.

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

snapshotBucketKey

\n
\n

boolean

\n

Whether or not snapshots where collected by the test.

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

stepId

\n
\n

int64

\n

The step ID.

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

subTestStepDetails

\n
\n

[object]

\n

If this step includes a sub-test.\nSubtests documentation.

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

timeToInteractive

\n
\n

double

\n

Time before starting the step.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

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

url

\n
\n

string

\n

URL to perform the step against.

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

value

\n
\n

\n

Value for the step.

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

vitalsMetrics

\n
\n

[object]

\n

Array of Core Web Vitals metrics for the step.

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

cls

\n
\n

double

\n

Cumulative Layout Shift.

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

lcp

\n
\n

double

\n

Largest Contentful Paint in milliseconds.

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

url

\n
\n

string

\n

URL attached to the metrics.

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

warnings

\n
\n

[object]

\n

Warning collected that didn't failed the step.

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

message [required]

\n
\n

string

\n

Message for the warning.

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

type [required]

\n
\n

enum

\n

User locator used. \nAllowed enum values: user_locator

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

thumbnailsBucketKey

\n
\n

boolean

\n

Whether or not a thumbnail is associated with the browser test.

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

timeToInteractive

\n
\n

double

\n

Time in second to wait before the browser test starts after\nreaching the start URL.

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

result_id

\n
\n

string

\n

ID of the browser test result.

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

status

\n
\n

enum

\n

The status of your Synthetic monitor.

\n
    \n
  • O for not triggered
    • \n
  • 1 for triggered
    • \n
  • 2 for no data \nAllowed enum values: 0,1,2
    • \n
\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

check

\n
\n

object

\n

Object describing the browser test configuration.

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

config [required]

\n
\n

object

\n

Configuration object for a Synthetic 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

\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

string

\n

Port to use when performing the test.

\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

variables

\n
\n

[object]

\n

Browser tests only - array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

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

check_time

\n
\n

double

\n

When the browser test was conducted.

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

check_version

\n
\n

int64

\n

Version of the browser test used.

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

probe_dc

\n
\n

string

\n

Location from which the browser test was performed.

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

result

\n
\n

object

\n

Object containing results for your Synthetic browser test.

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

browserType

\n
\n

string

\n

Type of browser device used for the browser test.

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

browserVersion

\n
\n

string

\n

Browser version used for the browser test.

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

device

\n
\n

object

\n

Object describing the device used to perform the Synthetic test.

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

height [required]

\n
\n

int64

\n

Screen height of the device.

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

id [required]

\n
\n

enum

\n

The device ID. \nAllowed enum values: laptop_large,tablet,mobile_small,chrome.laptop_large,chrome.tablet,chrome.mobile_small,firefox.laptop_large,firefox.tablet,firefox.mobile_small,edge.laptop_large,edge.tablet,edge.mobile_small

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

isMobile

\n
\n

boolean

\n

Whether or not the device is a mobile.

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

name [required]

\n
\n

string

\n

The device name.

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

width [required]

\n
\n

int64

\n

Screen width of the device.

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

duration

\n
\n

double

\n

Global duration in second of the browser test.

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

error

\n
\n

string

\n

Error returned for the browser test.

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

failure

\n
\n

object

\n

The browser test failure details.

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

code

\n
\n

enum

\n

Error code that can be returned by a Synthetic test. \nAllowed enum values: API_REQUEST_FAILURE,ASSERTION_FAILURE,DOWNLOAD_FILE_TOO_LARGE,ELEMENT_NOT_INTERACTABLE,EMAIL_VARIABLE_NOT_DEFINED,EVALUATE_JAVASCRIPT,EVALUATE_JAVASCRIPT_CONTEXT,EXTRACT_VARIABLE,FORBIDDEN_URL,FRAME_DETACHED,INCONSISTENCIES,INTERNAL_ERROR,INVALID_TYPE_TEXT_DELAY,INVALID_URL,INVALID_VARIABLE_PATTERN,INVISIBLE_ELEMENT,LOCATE_ELEMENT,NAVIGATE_TO_LINK,OPEN_URL,PRESS_KEY,SERVER_CERTIFICATE,SELECT_OPTION,STEP_TIMEOUT,SUB_TEST_NOT_PASSED,TEST_TIMEOUT,TOO_MANY_HTTP_REQUESTS,UNAVAILABLE_BROWSER,UNKNOWN,UNSUPPORTED_AUTH_SCHEMA,UPLOAD_FILES_ELEMENT_TYPE,UPLOAD_FILES_DIALOG,UPLOAD_FILES_DYNAMIC_ELEMENT,UPLOAD_FILES_NAME

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

message

\n
\n

string

\n

The browser test error message.

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

passed

\n
\n

boolean

\n

Whether or not the browser test was conducted.

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

receivedEmailCount

\n
\n

int64

\n

The amount of email received during the browser test.

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

startUrl

\n
\n

string

\n

Starting URL for the browser test.

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

stepDetails

\n
\n

[object]

\n

Array containing the different browser test steps.

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

browserErrors

\n
\n

[object]

\n

Array of errors collected for a browser test.

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

description [required]

\n
\n

string

\n

Description of the error.

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

name [required]

\n
\n

string

\n

Name of the error.

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

status

\n
\n

int64

\n

Status Code of the error.

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

type [required]

\n
\n

enum

\n

Error type returned by a browser test. \nAllowed enum values: network,js

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

checkType

\n
\n

enum

\n

Type of assertion to apply in an API test. \nAllowed enum values: equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty

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

description

\n
\n

string

\n

Description of the test.

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

duration

\n
\n

double

\n

Total duration in millisecond of the test.

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

error

\n
\n

string

\n

Error returned by the test.

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

playingTab

\n
\n

enum

\n

Navigate between different tabs for your browser test. \nAllowed enum values: -1,0,1,2,3

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

screenshotBucketKey

\n
\n

boolean

\n

Whether or not screenshots where collected by the test.

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

skipped

\n
\n

boolean

\n

Whether or not to skip this step.

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

snapshotBucketKey

\n
\n

boolean

\n

Whether or not snapshots where collected by the test.

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

stepId

\n
\n

int64

\n

The step ID.

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

subTestStepDetails

\n
\n

[object]

\n

If this step includes a sub-test.\nSubtests documentation.

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

timeToInteractive

\n
\n

double

\n

Time before starting the step.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

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

url

\n
\n

string

\n

URL to perform the step against.

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

value

\n
\n

\n

Value for the step.

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

vitalsMetrics

\n
\n

[object]

\n

Array of Core Web Vitals metrics for the step.

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

cls

\n
\n

double

\n

Cumulative Layout Shift.

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

lcp

\n
\n

double

\n

Largest Contentful Paint in milliseconds.

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

url

\n
\n

string

\n

URL attached to the metrics.

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

warnings

\n
\n

[object]

\n

Warning collected that didn't failed the step.

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

message [required]

\n
\n

string

\n

Message for the warning.

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

type [required]

\n
\n

enum

\n

User locator used. \nAllowed enum values: user_locator

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

thumbnailsBucketKey

\n
\n

boolean

\n

Whether or not a thumbnail is associated with the browser test.

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

timeToInteractive

\n
\n

double

\n

Time in second to wait before the browser test starts after\nreaching the start URL.

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

result_id

\n
\n

string

\n

ID of the browser test result.

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

status

\n
\n

enum

\n

The status of your Synthetic monitor.

\n
    \n
  • O for not triggered
    • \n
  • 1 for triggered
    • \n
  • 2 for no data \nAllowed enum values: 0,1,2
    • \n
\n
\n \n
\n
" }, "403": { "json": { @@ -3578,7 +3578,7 @@ "tags": [], "type": "string" }, - "html": "
\n
\n
\n
\n

config

\n
\n

object

\n

Configuration object for a Synthetic 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
\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

\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

string

\n

Port to use when performing the test.

\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

variables

\n
\n

[object]

\n

Browser tests only - array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

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

creator

\n
\n

object

\n

Object describing the creator of the shared element.

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

email

\n
\n

string

\n

Email of the creator.

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

handle

\n
\n

string

\n

Handle of the creator.

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

name

\n
\n

string

\n

Name of the creator.

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

locations

\n
\n

[string]

\n

Array of locations used to run the test.

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

message

\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

\n
\n

string

\n

Name of the test.

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

options

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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 test public ID.

\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

steps

\n
\n

[object]

\n

For browser test, the steps of the test.

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

allowFailure

\n
\n

boolean

\n

A boolean set to allow this step to fail.

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

isCritical

\n
\n

boolean

\n

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

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

name

\n
\n

string

\n

The name of the step.

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

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

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

params

\n
\n

object

\n

The parameters of the step.

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

timeout

\n
\n

int64

\n

The time before declaring a step failed.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

\n
\n \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

\n
\n

enum

\n

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

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

config

\n
\n

object

\n

Configuration object for a Synthetic 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

\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

string

\n

Port to use when performing the test.

\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

variables

\n
\n

[object]

\n

Browser tests only - array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

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

creator

\n
\n

object

\n

Object describing the creator of the shared element.

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

email

\n
\n

string

\n

Email of the creator.

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

handle

\n
\n

string

\n

Handle of the creator.

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

name

\n
\n

string

\n

Name of the creator.

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

locations

\n
\n

[string]

\n

Array of locations used to run the test.

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

message

\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

\n
\n

string

\n

Name of the test.

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

options

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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 test public ID.

\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

steps

\n
\n

[object]

\n

For browser test, the steps of the test.

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

allowFailure

\n
\n

boolean

\n

A boolean set to allow this step to fail.

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

isCritical

\n
\n

boolean

\n

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

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

name

\n
\n

string

\n

The name of the step.

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

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

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

params

\n
\n

object

\n

The parameters of the step.

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

timeout

\n
\n

int64

\n

The time before declaring a step failed.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

\n
\n \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

\n
\n

enum

\n

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

\n
\n \n
\n
" }, "403": { "json": { @@ -3789,7 +3789,7 @@ "tags": [], "type": "string" }, - "html": "
\n
\n
\n
\n

config

\n
\n

object

\n

Configuration object for a Synthetic 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
\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

\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

string

\n

Port to use when performing the test.

\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

variables

\n
\n

[object]

\n

Browser tests only - array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

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

creator

\n
\n

object

\n

Object describing the creator of the shared element.

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

email

\n
\n

string

\n

Email of the creator.

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

handle

\n
\n

string

\n

Handle of the creator.

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

name

\n
\n

string

\n

Name of the creator.

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

locations

\n
\n

[string]

\n

Array of locations used to run the test.

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

message

\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

\n
\n

string

\n

Name of the test.

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

options

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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 test public ID.

\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

steps

\n
\n

[object]

\n

For browser test, the steps of the test.

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

allowFailure

\n
\n

boolean

\n

A boolean set to allow this step to fail.

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

isCritical

\n
\n

boolean

\n

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

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

name

\n
\n

string

\n

The name of the step.

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

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

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

params

\n
\n

object

\n

The parameters of the step.

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

timeout

\n
\n

int64

\n

The time before declaring a step failed.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

\n
\n \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

\n
\n

enum

\n

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

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

config

\n
\n

object

\n

Configuration object for a Synthetic 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

\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

string

\n

Port to use when performing the test.

\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

variables

\n
\n

[object]

\n

Browser tests only - array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

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

creator

\n
\n

object

\n

Object describing the creator of the shared element.

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

email

\n
\n

string

\n

Email of the creator.

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

handle

\n
\n

string

\n

Handle of the creator.

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

name

\n
\n

string

\n

Name of the creator.

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

locations

\n
\n

[string]

\n

Array of locations used to run the test.

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

message

\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

\n
\n

string

\n

Name of the test.

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

options

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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 test public ID.

\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

steps

\n
\n

[object]

\n

For browser test, the steps of the test.

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

allowFailure

\n
\n

boolean

\n

A boolean set to allow this step to fail.

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

isCritical

\n
\n

boolean

\n

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

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

name

\n
\n

string

\n

The name of the step.

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

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

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

params

\n
\n

object

\n

The parameters of the step.

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

timeout

\n
\n

int64

\n

The time before declaring a step failed.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

\n
\n \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

\n
\n

enum

\n

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

\n
\n \n
\n
" }, "400": { "json": { @@ -4016,7 +4016,7 @@ "tags": [], "type": "string" }, - "html": "
\n
\n
\n
\n

config

\n
\n

object

\n

Configuration object for a Synthetic 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
\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

\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

string

\n

Port to use when performing the test.

\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

variables

\n
\n

[object]

\n

Browser tests only - array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

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

creator

\n
\n

object

\n

Object describing the creator of the shared element.

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

email

\n
\n

string

\n

Email of the creator.

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

handle

\n
\n

string

\n

Handle of the creator.

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

name

\n
\n

string

\n

Name of the creator.

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

locations

\n
\n

[string]

\n

Array of locations used to run the test.

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

message

\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

\n
\n

string

\n

Name of the test.

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

options

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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 test public ID.

\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

steps

\n
\n

[object]

\n

For browser test, the steps of the test.

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

allowFailure

\n
\n

boolean

\n

A boolean set to allow this step to fail.

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

isCritical

\n
\n

boolean

\n

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

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

name

\n
\n

string

\n

The name of the step.

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

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

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

params

\n
\n

object

\n

The parameters of the step.

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

timeout

\n
\n

int64

\n

The time before declaring a step failed.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

\n
\n \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

\n
\n

enum

\n

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

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

config

\n
\n

object

\n

Configuration object for a Synthetic 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

\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

string

\n

Port to use when performing the test.

\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

variables

\n
\n

[object]

\n

Browser tests only - array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

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

creator

\n
\n

object

\n

Object describing the creator of the shared element.

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

email

\n
\n

string

\n

Email of the creator.

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

handle

\n
\n

string

\n

Handle of the creator.

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

name

\n
\n

string

\n

Name of the creator.

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

locations

\n
\n

[string]

\n

Array of locations used to run the test.

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

message

\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

\n
\n

string

\n

Name of the test.

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

options

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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 test public ID.

\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

steps

\n
\n

[object]

\n

For browser test, the steps of the test.

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

allowFailure

\n
\n

boolean

\n

A boolean set to allow this step to fail.

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

isCritical

\n
\n

boolean

\n

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

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

name

\n
\n

string

\n

The name of the step.

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

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

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

params

\n
\n

object

\n

The parameters of the step.

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

timeout

\n
\n

int64

\n

The time before declaring a step failed.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

\n
\n \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

\n
\n

enum

\n

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

\n
\n \n
\n
" }, "400": { "json": { @@ -4246,7 +4246,7 @@ "tags": [], "type": "string" }, - "html": "
\n
\n
\n
\n

config

\n
\n

object

\n

Configuration object for a Synthetic 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
\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

\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

string

\n

Port to use when performing the test.

\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

variables

\n
\n

[object]

\n

Browser tests only - array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

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

creator

\n
\n

object

\n

Object describing the creator of the shared element.

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

email

\n
\n

string

\n

Email of the creator.

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

handle

\n
\n

string

\n

Handle of the creator.

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

name

\n
\n

string

\n

Name of the creator.

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

locations

\n
\n

[string]

\n

Array of locations used to run the test.

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

message

\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

\n
\n

string

\n

Name of the test.

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

options

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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 test public ID.

\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

steps

\n
\n

[object]

\n

For browser test, the steps of the test.

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

allowFailure

\n
\n

boolean

\n

A boolean set to allow this step to fail.

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

isCritical

\n
\n

boolean

\n

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

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

name

\n
\n

string

\n

The name of the step.

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

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

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

params

\n
\n

object

\n

The parameters of the step.

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

timeout

\n
\n

int64

\n

The time before declaring a step failed.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

\n
\n \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

\n
\n

enum

\n

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

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

config

\n
\n

object

\n

Configuration object for a Synthetic 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

\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

string

\n

Port to use when performing the test.

\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

variables

\n
\n

[object]

\n

Browser tests only - array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

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

creator

\n
\n

object

\n

Object describing the creator of the shared element.

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

email

\n
\n

string

\n

Email of the creator.

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

handle

\n
\n

string

\n

Handle of the creator.

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

name

\n
\n

string

\n

Name of the creator.

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

locations

\n
\n

[string]

\n

Array of locations used to run the test.

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

message

\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

\n
\n

string

\n

Name of the test.

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

options

\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

\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

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
\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

\n
\n

[object]

\n

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

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

day

\n
\n

int32

\n

Number representing the day of the week.

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

from

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone

\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 test public ID.

\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

steps

\n
\n

[object]

\n

For browser test, the steps of the test.

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

allowFailure

\n
\n

boolean

\n

A boolean set to allow this step to fail.

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

isCritical

\n
\n

boolean

\n

A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.

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

name

\n
\n

string

\n

The name of the step.

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

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

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

params

\n
\n

object

\n

The parameters of the step.

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

timeout

\n
\n

int64

\n

The time before declaring a step failed.

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

type

\n
\n

enum

\n

Step type used in your Synthetic test. \nAllowed enum values: assertCurrentUrl,assertElementAttribute,assertElementContent,assertElementPresent,assertEmail,assertFileDownload,assertFromJavascript,assertPageContains,assertPageLacks,click,extractFromJavascript,extractVariable,goToEmailLink,goToUrl,goToUrlAndMeasureTti,hover,playSubTest,pressKey,refresh,runApiTest,scroll,selectOption,typeText,uploadFiles,wait

\n
\n \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

\n
\n

enum

\n

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

\n
\n \n
\n
" } }, "GetAPITestLatestResults": { @@ -4474,7 +4474,7 @@ "result_id": "string", "status": "integer" }, - "html": "
\n
\n
\n
\n

check

\n
\n

object

\n

Object describing the API test configuration.

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

config [required]

\n
\n

object

\n

Configuration object for a Synthetic 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
\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

\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

string

\n

Port to use when performing the test.

\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

variables

\n
\n

[object]

\n

Browser tests only - array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

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

check_time

\n
\n

double

\n

When the API test was conducted.

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

check_version

\n
\n

int64

\n

Version of the API test used.

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

probe_dc

\n
\n

string

\n

Locations for which to query the API test results.

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

result

\n
\n

object

\n

Object containing results for your Synthetic API test.

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

cert

\n
\n

object

\n

Object describing the SSL certificate used for a Synthetic test.

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

cipher

\n
\n

string

\n

Cipher used for the connection.

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

exponent

\n
\n

double

\n

Exponent associated to the certificate.

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

extKeyUsage

\n
\n

[string]

\n

Array of extensions and details used for the certificate.

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

fingerprint

\n
\n

string

\n

MD5 digest of the DER-encoded Certificate information.

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

fingerprint256

\n
\n

string

\n

SHA-1 digest of the DER-encoded Certificate information.

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

issuer

\n
\n

object

\n

Object describing the issuer of a SSL certificate.

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

C

\n
\n

string

\n

Country Name that issued the certificate.

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

CN

\n
\n

string

\n

Common Name that issued certificate.

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

L

\n
\n

string

\n

Locality that issued the certificate.

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

O

\n
\n

string

\n

Organization that issued the certificate.

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

OU

\n
\n

string

\n

Organizational Unit that issued the certificate.

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

ST

\n
\n

string

\n

State Or Province Name that issued the certificate.

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

modulus

\n
\n

string

\n

Modulus associated to the SSL certificate private key.

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

protocol

\n
\n

string

\n

TLS protocol used for the test.

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

serialNumber

\n
\n

string

\n

Serial Number assigned by Symantec to the SSL certificate.

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

subject

\n
\n

object

\n

Object describing the SSL certificate used for the test.

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

C

\n
\n

string

\n

Country Name associated with the certificate.

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

CN

\n
\n

string

\n

Common Name that associated with the certificate.

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

L

\n
\n

string

\n

Locality associated with the certificate.

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

O

\n
\n

string

\n

Organization associated with the certificate.

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

OU

\n
\n

string

\n

Organizational Unit associated with the certificate.

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

ST

\n
\n

string

\n

State Or Province Name associated with the certificate.

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

altName

\n
\n

string

\n

Subject Alternative Name associated with the certificate.

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

validFrom

\n
\n

date-time

\n

Date from which the SSL certificate is valid.

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

validTo

\n
\n

date-time

\n

Date until which the SSL certificate is valid.

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

eventType

\n
\n

enum

\n

Status of a Synthetic test. \nAllowed enum values: not_scheduled,scheduled,finished,finished_with_error

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

failure

\n
\n

object

\n

The API test failure details.

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

code

\n
\n

enum

\n

Error code that can be returned by a Synthetic test. \nAllowed enum values: BODY_TOO_LARGE,DENIED,TOO_MANY_REDIRECTS,AUTHENTICATION_ERROR,DECRYPTION,INVALID_CHAR_IN_HEADER,HEADER_TOO_LARGE,HEADERS_INCOMPATIBLE_CONTENT_LENGTH,INVALID_REQUEST,REQUIRES_UPDATE,UNESCAPED_CHARACTERS_IN_REQUEST_PATH,MALFORMED_RESPONSE,INCORRECT_ASSERTION,CONNREFUSED,CONNRESET,DNS,HOSTUNREACH,NETUNREACH,TIMEOUT,SSL,OCSP,INVALID_TEST,TUNNEL,WEBSOCKET,UNKNOWN,INTERNAL_ERROR

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

message

\n
\n

string

\n

The API test error message.

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

httpStatusCode

\n
\n

int64

\n

The API test HTTP status code.

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

requestHeaders

\n
\n

object

\n

Request header object used for the API test.

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

<any-key>

\n
\n

object

\n

Requested request header.

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

responseBody

\n
\n

string

\n

Response body returned for the API test.

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

responseHeaders

\n
\n

object

\n

Response headers returned for the API test.

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

<any-key>

\n
\n

\n

Returned request header.

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

responseSize

\n
\n

int64

\n

Global size in byte of the API test response.

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

timings

\n
\n

object

\n

Object containing all metrics and their values collected for a Synthetic API test.\nSee the Synthetic Monitoring Metrics documentation.

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

dns

\n
\n

double

\n

The duration in millisecond of the DNS lookup.

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

download

\n
\n

double

\n

The time in millisecond to download the response.

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

firstByte

\n
\n

double

\n

The time in millisecond to first byte.

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

handshake

\n
\n

double

\n

The duration in millisecond of the TLS handshake.

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

redirect

\n
\n

double

\n

The time in millisecond spent during redirections.

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

ssl

\n
\n

double

\n

The duration in millisecond of the TLS handshake.

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

tcp

\n
\n

double

\n

Time in millisecond to establish the TCP connection.

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

total

\n
\n

double

\n

The overall time in millisecond the request took to be processed.

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

wait

\n
\n

double

\n

Time spent in millisecond waiting for a response.

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

result_id

\n
\n

string

\n

ID of the API test result.

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

status

\n
\n

enum

\n

The status of your Synthetic monitor.

\n
    \n
  • O for not triggered
    • \n
  • 1 for triggered
    • \n
  • 2 for no data \nAllowed enum values: 0,1,2
    • \n
\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

check

\n
\n

object

\n

Object describing the API test configuration.

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

config [required]

\n
\n

object

\n

Configuration object for a Synthetic 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

\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

string

\n

Port to use when performing the test.

\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

variables

\n
\n

[object]

\n

Browser tests only - array of variables used for the test steps.

\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 for the variable. Global variables require an ID.

\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

Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.

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

type [required]

\n
\n

enum

\n

Type of browser test variable. \nAllowed enum values: element,email,global,javascript,text

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

check_time

\n
\n

double

\n

When the API test was conducted.

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

check_version

\n
\n

int64

\n

Version of the API test used.

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

probe_dc

\n
\n

string

\n

Locations for which to query the API test results.

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

result

\n
\n

object

\n

Object containing results for your Synthetic API test.

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

cert

\n
\n

object

\n

Object describing the SSL certificate used for a Synthetic test.

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

cipher

\n
\n

string

\n

Cipher used for the connection.

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

exponent

\n
\n

double

\n

Exponent associated to the certificate.

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

extKeyUsage

\n
\n

[string]

\n

Array of extensions and details used for the certificate.

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

fingerprint

\n
\n

string

\n

MD5 digest of the DER-encoded Certificate information.

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

fingerprint256

\n
\n

string

\n

SHA-1 digest of the DER-encoded Certificate information.

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

issuer

\n
\n

object

\n

Object describing the issuer of a SSL certificate.

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

C

\n
\n

string

\n

Country Name that issued the certificate.

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

CN

\n
\n

string

\n

Common Name that issued certificate.

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

L

\n
\n

string

\n

Locality that issued the certificate.

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

O

\n
\n

string

\n

Organization that issued the certificate.

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

OU

\n
\n

string

\n

Organizational Unit that issued the certificate.

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

ST

\n
\n

string

\n

State Or Province Name that issued the certificate.

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

modulus

\n
\n

string

\n

Modulus associated to the SSL certificate private key.

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

protocol

\n
\n

string

\n

TLS protocol used for the test.

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

serialNumber

\n
\n

string

\n

Serial Number assigned by Symantec to the SSL certificate.

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

subject

\n
\n

object

\n

Object describing the SSL certificate used for the test.

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

C

\n
\n

string

\n

Country Name associated with the certificate.

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

CN

\n
\n

string

\n

Common Name that associated with the certificate.

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

L

\n
\n

string

\n

Locality associated with the certificate.

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

O

\n
\n

string

\n

Organization associated with the certificate.

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

OU

\n
\n

string

\n

Organizational Unit associated with the certificate.

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

ST

\n
\n

string

\n

State Or Province Name associated with the certificate.

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

altName

\n
\n

string

\n

Subject Alternative Name associated with the certificate.

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

validFrom

\n
\n

date-time

\n

Date from which the SSL certificate is valid.

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

validTo

\n
\n

date-time

\n

Date until which the SSL certificate is valid.

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

eventType

\n
\n

enum

\n

Status of a Synthetic test. \nAllowed enum values: not_scheduled,scheduled,finished,finished_with_error

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

failure

\n
\n

object

\n

The API test failure details.

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

code

\n
\n

enum

\n

Error code that can be returned by a Synthetic test. \nAllowed enum values: BODY_TOO_LARGE,DENIED,TOO_MANY_REDIRECTS,AUTHENTICATION_ERROR,DECRYPTION,INVALID_CHAR_IN_HEADER,HEADER_TOO_LARGE,HEADERS_INCOMPATIBLE_CONTENT_LENGTH,INVALID_REQUEST,REQUIRES_UPDATE,UNESCAPED_CHARACTERS_IN_REQUEST_PATH,MALFORMED_RESPONSE,INCORRECT_ASSERTION,CONNREFUSED,CONNRESET,DNS,HOSTUNREACH,NETUNREACH,TIMEOUT,SSL,OCSP,INVALID_TEST,TUNNEL,WEBSOCKET,UNKNOWN,INTERNAL_ERROR

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

message

\n
\n

string

\n

The API test error message.

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

httpStatusCode

\n
\n

int64

\n

The API test HTTP status code.

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

requestHeaders

\n
\n

object

\n

Request header object used for the API test.

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

<any-key>

\n
\n

object

\n

Requested request header.

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

responseBody

\n
\n

string

\n

Response body returned for the API test.

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

responseHeaders

\n
\n

object

\n

Response headers returned for the API test.

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

<any-key>

\n
\n

\n

Returned request header.

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

responseSize

\n
\n

int64

\n

Global size in byte of the API test response.

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

timings

\n
\n

object

\n

Object containing all metrics and their values collected for a Synthetic API test.\nSee the Synthetic Monitoring Metrics documentation.

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

dns

\n
\n

double

\n

The duration in millisecond of the DNS lookup.

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

download

\n
\n

double

\n

The time in millisecond to download the response.

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

firstByte

\n
\n

double

\n

The time in millisecond to first byte.

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

handshake

\n
\n

double

\n

The duration in millisecond of the TLS handshake.

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

redirect

\n
\n

double

\n

The time in millisecond spent during redirections.

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

ssl

\n
\n

double

\n

The duration in millisecond of the TLS handshake.

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

tcp

\n
\n

double

\n

Time in millisecond to establish the TCP connection.

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

total

\n
\n

double

\n

The overall time in millisecond the request took to be processed.

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

wait

\n
\n

double

\n

Time spent in millisecond waiting for a response.

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

result_id

\n
\n

string

\n

ID of the API test result.

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

status

\n
\n

enum

\n

The status of your Synthetic monitor.

\n
    \n
  • O for not triggered
    • \n
  • 1 for triggered
    • \n
  • 2 for no data \nAllowed enum values: 0,1,2
    • \n
\n
\n \n
\n
" }, "403": { "json": { diff --git a/content/en/api/v1/synthetics/request.CreateSyntheticsAPITest_1487281163.json b/content/en/api/v1/synthetics/request.CreateSyntheticsAPITest_1487281163.json index 366eb13783538..0a4fe195c6356 100644 --- a/content/en/api/v1/synthetics/request.CreateSyntheticsAPITest_1487281163.json +++ b/content/en/api/v1/synthetics/request.CreateSyntheticsAPITest_1487281163.json @@ -53,6 +53,10 @@ "operator": "md5", "target": "a", "type": "bodyHash" + }, + { + "code": "const hello = 'world';", + "type": "javascript" } ], "configVariables": [ diff --git a/content/en/api/v1/synthetics/request.CreateSyntheticsAPITest_1987645492.json b/content/en/api/v1/synthetics/request.CreateSyntheticsAPITest_1987645492.json index 366eb13783538..0a4fe195c6356 100644 --- a/content/en/api/v1/synthetics/request.CreateSyntheticsAPITest_1987645492.json +++ b/content/en/api/v1/synthetics/request.CreateSyntheticsAPITest_1987645492.json @@ -53,6 +53,10 @@ "operator": "md5", "target": "a", "type": "bodyHash" + }, + { + "code": "const hello = 'world';", + "type": "javascript" } ], "configVariables": [ diff --git a/data/api/v1/full_spec.yaml b/data/api/v1/full_spec.yaml index b597e8c3323ac..2d1c5d13cf044 100644 --- a/data/api/v1/full_spec.yaml +++ b/data/api/v1/full_spec.yaml @@ -14109,6 +14109,7 @@ components: - $ref: '#/components/schemas/SyntheticsAssertionJSONPathTarget' - $ref: '#/components/schemas/SyntheticsAssertionJSONSchemaTarget' - $ref: '#/components/schemas/SyntheticsAssertionXPathTarget' + - $ref: '#/components/schemas/SyntheticsAssertionJavascript' SyntheticsAssertionBodyHashOperator: description: Assertion operator to apply. enum: @@ -14225,6 +14226,27 @@ components: metaSchema: $ref: '#/components/schemas/SyntheticsAssertionJSONSchemaMetaSchema' type: object + SyntheticsAssertionJavascript: + description: A JavaScript assertion. + properties: + code: + description: The JavaScript code that performs the assertions. + example: dd.expect(dd.response.statusCode).to.equal(200); + type: string + type: + $ref: '#/components/schemas/SyntheticsAssertionJavascriptType' + required: + - type + - code + type: object + SyntheticsAssertionJavascriptType: + description: Type of the assertion. + enum: + - javascript + example: javascript + type: string + x-enum-varnames: + - JAVASCRIPT SyntheticsAssertionOperator: description: Assertion operator to apply. enum: diff --git a/data/api/v1/full_spec_deref.json b/data/api/v1/full_spec_deref.json index f7e60644219da..13fba83f88ea9 100644 --- a/data/api/v1/full_spec_deref.json +++ b/data/api/v1/full_spec_deref.json @@ -485807,6 +485807,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -487014,6 +487040,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -488102,6 +488154,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -489697,6 +489775,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -490785,6 +490889,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -492276,6 +492406,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -493741,6 +493897,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -495043,6 +495225,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -496386,6 +496594,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -496716,6 +496950,43 @@ }, "type": "object" }, + "SyntheticsAssertionJavascript": { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" + }, + "SyntheticsAssertionJavascriptType": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + }, "SyntheticsAssertionOperator": { "description": "Assertion operator to apply.", "enum": [ @@ -498694,6 +498965,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -500278,6 +500575,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -502046,6 +502369,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -503686,6 +504035,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -507539,6 +507914,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -510394,6 +510795,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -511527,6 +511954,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1061554,6 +1062007,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1063293,6 +1063772,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1064915,6 +1065420,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1066861,6 +1067392,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1067949,6 +1068506,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1069556,6 +1070139,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1070644,6 +1071253,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1072436,6 +1073071,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1073524,6 +1074185,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1075248,6 +1075935,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1076336,6 +1077049,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1077626,64 +1078365,247 @@ }, "required": [ "type", - "operator", - "target" - ], - "type": "object" - }, - { - "description": "An assertion which targets body hash.", - "properties": { - "operator": { - "description": "Assertion operator to apply.", - "enum": [ - "md5", - "sha1", - "sha256" - ], - "example": "md5", - "type": "string", - "x-enum-varnames": [ - "MD5", - "SHA1", - "SHA256" - ] - }, - "target": { - "description": "Value used by the operator.", - "example": 123456 - }, - "type": { - "description": "Type of the assertion.", - "enum": [ - "bodyHash" - ], - "example": "bodyHash", - "type": "string", - "x-enum-varnames": [ - "BODY_HASH" - ] - } - }, - "required": [ - "type", - "operator", - "target" + "operator", + "target" + ], + "type": "object" + }, + { + "description": "An assertion which targets body hash.", + "properties": { + "operator": { + "description": "Assertion operator to apply.", + "enum": [ + "md5", + "sha1", + "sha256" + ], + "example": "md5", + "type": "string", + "x-enum-varnames": [ + "MD5", + "SHA1", + "SHA256" + ] + }, + "target": { + "description": "Value used by the operator.", + "example": 123456 + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "bodyHash" + ], + "example": "bodyHash", + "type": "string", + "x-enum-varnames": [ + "BODY_HASH" + ] + } + }, + "required": [ + "type", + "operator", + "target" + ], + "type": "object" + }, + { + "description": "An assertion for the `validatesJSONPath` operator.", + "properties": { + "operator": { + "description": "Assertion operator to apply.", + "enum": [ + "validatesJSONPath" + ], + "example": "validatesJSONPath", + "type": "string", + "x-enum-varnames": [ + "VALIDATES_JSON_PATH" + ] + }, + "property": { + "description": "The associated assertion property.", + "type": "string" + }, + "target": { + "description": "Composed target for `validatesJSONPath` operator.", + "properties": { + "elementsOperator": { + "description": "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`.", + "type": "string" + }, + "jsonPath": { + "description": "The JSON path to assert.", + "type": "string" + }, + "operator": { + "description": "The specific operator to use on the path.", + "type": "string" + }, + "targetValue": { + "description": "The path target value to compare to." + } + }, + "type": "object" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "body", + "header", + "statusCode", + "certificate", + "responseTime", + "property", + "recordEvery", + "recordSome", + "tlsVersion", + "minTlsVersion", + "latency", + "packetLossPercentage", + "packetsReceived", + "networkHop", + "receivedMessage", + "grpcHealthcheckStatus", + "grpcMetadata", + "grpcProto", + "connection" + ], + "example": "statusCode", + "type": "string", + "x-enum-varnames": [ + "BODY", + "HEADER", + "STATUS_CODE", + "CERTIFICATE", + "RESPONSE_TIME", + "PROPERTY", + "RECORD_EVERY", + "RECORD_SOME", + "TLS_VERSION", + "MIN_TLS_VERSION", + "LATENCY", + "PACKET_LOSS_PERCENTAGE", + "PACKETS_RECEIVED", + "NETWORK_HOP", + "RECEIVED_MESSAGE", + "GRPC_HEALTHCHECK_STATUS", + "GRPC_METADATA", + "GRPC_PROTO", + "CONNECTION" + ] + } + }, + "required": [ + "type", + "operator" + ], + "type": "object" + }, + { + "description": "An assertion for the `validatesJSONSchema` operator.", + "properties": { + "operator": { + "description": "Assertion operator to apply.", + "enum": [ + "validatesJSONSchema" + ], + "example": "validatesJSONSchema", + "type": "string", + "x-enum-varnames": [ + "VALIDATES_JSON_SCHEMA" + ] + }, + "target": { + "description": "Composed target for `validatesJSONSchema` operator.", + "properties": { + "jsonSchema": { + "description": "The JSON Schema to assert.", + "type": "string" + }, + "metaSchema": { + "description": "The JSON Schema meta-schema version used in the assertion.", + "enum": [ + "draft-07", + "draft-06" + ], + "type": "string", + "x-enum-varnames": [ + "DRAFT_07", + "DRAFT_06" + ] + } + }, + "type": "object" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "body", + "header", + "statusCode", + "certificate", + "responseTime", + "property", + "recordEvery", + "recordSome", + "tlsVersion", + "minTlsVersion", + "latency", + "packetLossPercentage", + "packetsReceived", + "networkHop", + "receivedMessage", + "grpcHealthcheckStatus", + "grpcMetadata", + "grpcProto", + "connection" + ], + "example": "statusCode", + "type": "string", + "x-enum-varnames": [ + "BODY", + "HEADER", + "STATUS_CODE", + "CERTIFICATE", + "RESPONSE_TIME", + "PROPERTY", + "RECORD_EVERY", + "RECORD_SOME", + "TLS_VERSION", + "MIN_TLS_VERSION", + "LATENCY", + "PACKET_LOSS_PERCENTAGE", + "PACKETS_RECEIVED", + "NETWORK_HOP", + "RECEIVED_MESSAGE", + "GRPC_HEALTHCHECK_STATUS", + "GRPC_METADATA", + "GRPC_PROTO", + "CONNECTION" + ] + } + }, + "required": [ + "type", + "operator" ], "type": "object" }, { - "description": "An assertion for the `validatesJSONPath` operator.", + "description": "An assertion for the `validatesXPath` operator.", "properties": { "operator": { "description": "Assertion operator to apply.", "enum": [ - "validatesJSONPath" + "validatesXPath" ], - "example": "validatesJSONPath", + "example": "validatesXPath", "type": "string", "x-enum-varnames": [ - "VALIDATES_JSON_PATH" + "VALIDATES_X_PATH" ] }, "property": { @@ -1077691,112 +1078613,18 @@ "type": "string" }, "target": { - "description": "Composed target for `validatesJSONPath` operator.", + "description": "Composed target for `validatesXPath` operator.", "properties": { - "elementsOperator": { - "description": "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`.", - "type": "string" - }, - "jsonPath": { - "description": "The JSON path to assert.", - "type": "string" - }, "operator": { "description": "The specific operator to use on the path.", "type": "string" }, "targetValue": { "description": "The path target value to compare to." - } - }, - "type": "object" - }, - "type": { - "description": "Type of the assertion.", - "enum": [ - "body", - "header", - "statusCode", - "certificate", - "responseTime", - "property", - "recordEvery", - "recordSome", - "tlsVersion", - "minTlsVersion", - "latency", - "packetLossPercentage", - "packetsReceived", - "networkHop", - "receivedMessage", - "grpcHealthcheckStatus", - "grpcMetadata", - "grpcProto", - "connection" - ], - "example": "statusCode", - "type": "string", - "x-enum-varnames": [ - "BODY", - "HEADER", - "STATUS_CODE", - "CERTIFICATE", - "RESPONSE_TIME", - "PROPERTY", - "RECORD_EVERY", - "RECORD_SOME", - "TLS_VERSION", - "MIN_TLS_VERSION", - "LATENCY", - "PACKET_LOSS_PERCENTAGE", - "PACKETS_RECEIVED", - "NETWORK_HOP", - "RECEIVED_MESSAGE", - "GRPC_HEALTHCHECK_STATUS", - "GRPC_METADATA", - "GRPC_PROTO", - "CONNECTION" - ] - } - }, - "required": [ - "type", - "operator" - ], - "type": "object" - }, - { - "description": "An assertion for the `validatesJSONSchema` operator.", - "properties": { - "operator": { - "description": "Assertion operator to apply.", - "enum": [ - "validatesJSONSchema" - ], - "example": "validatesJSONSchema", - "type": "string", - "x-enum-varnames": [ - "VALIDATES_JSON_SCHEMA" - ] - }, - "target": { - "description": "Composed target for `validatesJSONSchema` operator.", - "properties": { - "jsonSchema": { - "description": "The JSON Schema to assert.", - "type": "string" }, - "metaSchema": { - "description": "The JSON Schema meta-schema version used in the assertion.", - "enum": [ - "draft-07", - "draft-06" - ], - "type": "string", - "x-enum-varnames": [ - "DRAFT_07", - "DRAFT_06" - ] + "xPath": { + "description": "The X path to assert.", + "type": "string" } }, "type": "object" @@ -1077856,91 +1078684,28 @@ "type": "object" }, { - "description": "An assertion for the `validatesXPath` operator.", + "description": "A JavaScript assertion.", "properties": { - "operator": { - "description": "Assertion operator to apply.", - "enum": [ - "validatesXPath" - ], - "example": "validatesXPath", - "type": "string", - "x-enum-varnames": [ - "VALIDATES_X_PATH" - ] - }, - "property": { - "description": "The associated assertion property.", + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", "type": "string" }, - "target": { - "description": "Composed target for `validatesXPath` operator.", - "properties": { - "operator": { - "description": "The specific operator to use on the path.", - "type": "string" - }, - "targetValue": { - "description": "The path target value to compare to." - }, - "xPath": { - "description": "The X path to assert.", - "type": "string" - } - }, - "type": "object" - }, "type": { "description": "Type of the assertion.", "enum": [ - "body", - "header", - "statusCode", - "certificate", - "responseTime", - "property", - "recordEvery", - "recordSome", - "tlsVersion", - "minTlsVersion", - "latency", - "packetLossPercentage", - "packetsReceived", - "networkHop", - "receivedMessage", - "grpcHealthcheckStatus", - "grpcMetadata", - "grpcProto", - "connection" + "javascript" ], - "example": "statusCode", + "example": "javascript", "type": "string", "x-enum-varnames": [ - "BODY", - "HEADER", - "STATUS_CODE", - "CERTIFICATE", - "RESPONSE_TIME", - "PROPERTY", - "RECORD_EVERY", - "RECORD_SOME", - "TLS_VERSION", - "MIN_TLS_VERSION", - "LATENCY", - "PACKET_LOSS_PERCENTAGE", - "PACKETS_RECEIVED", - "NETWORK_HOP", - "RECEIVED_MESSAGE", - "GRPC_HEALTHCHECK_STATUS", - "GRPC_METADATA", - "GRPC_PROTO", - "CONNECTION" + "JAVASCRIPT" ] } }, "required": [ "type", - "operator" + "code" ], "type": "object" } @@ -1079031,6 +1079796,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1080756,6 +1081547,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1082352,6 +1083169,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1084104,6 +1084947,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1085500,64 +1086369,247 @@ }, "required": [ "type", - "operator", - "target" - ], - "type": "object" - }, - { - "description": "An assertion which targets body hash.", - "properties": { - "operator": { - "description": "Assertion operator to apply.", - "enum": [ - "md5", - "sha1", - "sha256" - ], - "example": "md5", - "type": "string", - "x-enum-varnames": [ - "MD5", - "SHA1", - "SHA256" - ] - }, - "target": { - "description": "Value used by the operator.", - "example": 123456 - }, - "type": { - "description": "Type of the assertion.", - "enum": [ - "bodyHash" - ], - "example": "bodyHash", - "type": "string", - "x-enum-varnames": [ - "BODY_HASH" - ] - } - }, - "required": [ - "type", - "operator", - "target" + "operator", + "target" + ], + "type": "object" + }, + { + "description": "An assertion which targets body hash.", + "properties": { + "operator": { + "description": "Assertion operator to apply.", + "enum": [ + "md5", + "sha1", + "sha256" + ], + "example": "md5", + "type": "string", + "x-enum-varnames": [ + "MD5", + "SHA1", + "SHA256" + ] + }, + "target": { + "description": "Value used by the operator.", + "example": 123456 + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "bodyHash" + ], + "example": "bodyHash", + "type": "string", + "x-enum-varnames": [ + "BODY_HASH" + ] + } + }, + "required": [ + "type", + "operator", + "target" + ], + "type": "object" + }, + { + "description": "An assertion for the `validatesJSONPath` operator.", + "properties": { + "operator": { + "description": "Assertion operator to apply.", + "enum": [ + "validatesJSONPath" + ], + "example": "validatesJSONPath", + "type": "string", + "x-enum-varnames": [ + "VALIDATES_JSON_PATH" + ] + }, + "property": { + "description": "The associated assertion property.", + "type": "string" + }, + "target": { + "description": "Composed target for `validatesJSONPath` operator.", + "properties": { + "elementsOperator": { + "description": "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`.", + "type": "string" + }, + "jsonPath": { + "description": "The JSON path to assert.", + "type": "string" + }, + "operator": { + "description": "The specific operator to use on the path.", + "type": "string" + }, + "targetValue": { + "description": "The path target value to compare to." + } + }, + "type": "object" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "body", + "header", + "statusCode", + "certificate", + "responseTime", + "property", + "recordEvery", + "recordSome", + "tlsVersion", + "minTlsVersion", + "latency", + "packetLossPercentage", + "packetsReceived", + "networkHop", + "receivedMessage", + "grpcHealthcheckStatus", + "grpcMetadata", + "grpcProto", + "connection" + ], + "example": "statusCode", + "type": "string", + "x-enum-varnames": [ + "BODY", + "HEADER", + "STATUS_CODE", + "CERTIFICATE", + "RESPONSE_TIME", + "PROPERTY", + "RECORD_EVERY", + "RECORD_SOME", + "TLS_VERSION", + "MIN_TLS_VERSION", + "LATENCY", + "PACKET_LOSS_PERCENTAGE", + "PACKETS_RECEIVED", + "NETWORK_HOP", + "RECEIVED_MESSAGE", + "GRPC_HEALTHCHECK_STATUS", + "GRPC_METADATA", + "GRPC_PROTO", + "CONNECTION" + ] + } + }, + "required": [ + "type", + "operator" + ], + "type": "object" + }, + { + "description": "An assertion for the `validatesJSONSchema` operator.", + "properties": { + "operator": { + "description": "Assertion operator to apply.", + "enum": [ + "validatesJSONSchema" + ], + "example": "validatesJSONSchema", + "type": "string", + "x-enum-varnames": [ + "VALIDATES_JSON_SCHEMA" + ] + }, + "target": { + "description": "Composed target for `validatesJSONSchema` operator.", + "properties": { + "jsonSchema": { + "description": "The JSON Schema to assert.", + "type": "string" + }, + "metaSchema": { + "description": "The JSON Schema meta-schema version used in the assertion.", + "enum": [ + "draft-07", + "draft-06" + ], + "type": "string", + "x-enum-varnames": [ + "DRAFT_07", + "DRAFT_06" + ] + } + }, + "type": "object" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "body", + "header", + "statusCode", + "certificate", + "responseTime", + "property", + "recordEvery", + "recordSome", + "tlsVersion", + "minTlsVersion", + "latency", + "packetLossPercentage", + "packetsReceived", + "networkHop", + "receivedMessage", + "grpcHealthcheckStatus", + "grpcMetadata", + "grpcProto", + "connection" + ], + "example": "statusCode", + "type": "string", + "x-enum-varnames": [ + "BODY", + "HEADER", + "STATUS_CODE", + "CERTIFICATE", + "RESPONSE_TIME", + "PROPERTY", + "RECORD_EVERY", + "RECORD_SOME", + "TLS_VERSION", + "MIN_TLS_VERSION", + "LATENCY", + "PACKET_LOSS_PERCENTAGE", + "PACKETS_RECEIVED", + "NETWORK_HOP", + "RECEIVED_MESSAGE", + "GRPC_HEALTHCHECK_STATUS", + "GRPC_METADATA", + "GRPC_PROTO", + "CONNECTION" + ] + } + }, + "required": [ + "type", + "operator" ], "type": "object" }, { - "description": "An assertion for the `validatesJSONPath` operator.", + "description": "An assertion for the `validatesXPath` operator.", "properties": { "operator": { "description": "Assertion operator to apply.", "enum": [ - "validatesJSONPath" + "validatesXPath" ], - "example": "validatesJSONPath", + "example": "validatesXPath", "type": "string", "x-enum-varnames": [ - "VALIDATES_JSON_PATH" + "VALIDATES_X_PATH" ] }, "property": { @@ -1085565,112 +1086617,18 @@ "type": "string" }, "target": { - "description": "Composed target for `validatesJSONPath` operator.", + "description": "Composed target for `validatesXPath` operator.", "properties": { - "elementsOperator": { - "description": "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`.", - "type": "string" - }, - "jsonPath": { - "description": "The JSON path to assert.", - "type": "string" - }, "operator": { "description": "The specific operator to use on the path.", "type": "string" }, "targetValue": { "description": "The path target value to compare to." - } - }, - "type": "object" - }, - "type": { - "description": "Type of the assertion.", - "enum": [ - "body", - "header", - "statusCode", - "certificate", - "responseTime", - "property", - "recordEvery", - "recordSome", - "tlsVersion", - "minTlsVersion", - "latency", - "packetLossPercentage", - "packetsReceived", - "networkHop", - "receivedMessage", - "grpcHealthcheckStatus", - "grpcMetadata", - "grpcProto", - "connection" - ], - "example": "statusCode", - "type": "string", - "x-enum-varnames": [ - "BODY", - "HEADER", - "STATUS_CODE", - "CERTIFICATE", - "RESPONSE_TIME", - "PROPERTY", - "RECORD_EVERY", - "RECORD_SOME", - "TLS_VERSION", - "MIN_TLS_VERSION", - "LATENCY", - "PACKET_LOSS_PERCENTAGE", - "PACKETS_RECEIVED", - "NETWORK_HOP", - "RECEIVED_MESSAGE", - "GRPC_HEALTHCHECK_STATUS", - "GRPC_METADATA", - "GRPC_PROTO", - "CONNECTION" - ] - } - }, - "required": [ - "type", - "operator" - ], - "type": "object" - }, - { - "description": "An assertion for the `validatesJSONSchema` operator.", - "properties": { - "operator": { - "description": "Assertion operator to apply.", - "enum": [ - "validatesJSONSchema" - ], - "example": "validatesJSONSchema", - "type": "string", - "x-enum-varnames": [ - "VALIDATES_JSON_SCHEMA" - ] - }, - "target": { - "description": "Composed target for `validatesJSONSchema` operator.", - "properties": { - "jsonSchema": { - "description": "The JSON Schema to assert.", - "type": "string" }, - "metaSchema": { - "description": "The JSON Schema meta-schema version used in the assertion.", - "enum": [ - "draft-07", - "draft-06" - ], - "type": "string", - "x-enum-varnames": [ - "DRAFT_07", - "DRAFT_06" - ] + "xPath": { + "description": "The X path to assert.", + "type": "string" } }, "type": "object" @@ -1085730,91 +1086688,28 @@ "type": "object" }, { - "description": "An assertion for the `validatesXPath` operator.", + "description": "A JavaScript assertion.", "properties": { - "operator": { - "description": "Assertion operator to apply.", - "enum": [ - "validatesXPath" - ], - "example": "validatesXPath", - "type": "string", - "x-enum-varnames": [ - "VALIDATES_X_PATH" - ] - }, - "property": { - "description": "The associated assertion property.", + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", "type": "string" }, - "target": { - "description": "Composed target for `validatesXPath` operator.", - "properties": { - "operator": { - "description": "The specific operator to use on the path.", - "type": "string" - }, - "targetValue": { - "description": "The path target value to compare to." - }, - "xPath": { - "description": "The X path to assert.", - "type": "string" - } - }, - "type": "object" - }, "type": { "description": "Type of the assertion.", "enum": [ - "body", - "header", - "statusCode", - "certificate", - "responseTime", - "property", - "recordEvery", - "recordSome", - "tlsVersion", - "minTlsVersion", - "latency", - "packetLossPercentage", - "packetsReceived", - "networkHop", - "receivedMessage", - "grpcHealthcheckStatus", - "grpcMetadata", - "grpcProto", - "connection" + "javascript" ], - "example": "statusCode", + "example": "javascript", "type": "string", "x-enum-varnames": [ - "BODY", - "HEADER", - "STATUS_CODE", - "CERTIFICATE", - "RESPONSE_TIME", - "PROPERTY", - "RECORD_EVERY", - "RECORD_SOME", - "TLS_VERSION", - "MIN_TLS_VERSION", - "LATENCY", - "PACKET_LOSS_PERCENTAGE", - "PACKETS_RECEIVED", - "NETWORK_HOP", - "RECEIVED_MESSAGE", - "GRPC_HEALTHCHECK_STATUS", - "GRPC_METADATA", - "GRPC_PROTO", - "CONNECTION" + "JAVASCRIPT" ] } }, "required": [ "type", - "operator" + "code" ], "type": "object" } @@ -1087413,6 +1088308,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1089473,6 +1090394,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1092392,6 +1093339,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1094197,6 +1095170,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1095649,64 +1096648,247 @@ }, "required": [ "type", - "operator", - "target" - ], - "type": "object" - }, - { - "description": "An assertion which targets body hash.", - "properties": { - "operator": { - "description": "Assertion operator to apply.", - "enum": [ - "md5", - "sha1", - "sha256" - ], - "example": "md5", - "type": "string", - "x-enum-varnames": [ - "MD5", - "SHA1", - "SHA256" - ] - }, - "target": { - "description": "Value used by the operator.", - "example": 123456 - }, - "type": { - "description": "Type of the assertion.", - "enum": [ - "bodyHash" - ], - "example": "bodyHash", - "type": "string", - "x-enum-varnames": [ - "BODY_HASH" - ] - } - }, - "required": [ - "type", - "operator", - "target" + "operator", + "target" + ], + "type": "object" + }, + { + "description": "An assertion which targets body hash.", + "properties": { + "operator": { + "description": "Assertion operator to apply.", + "enum": [ + "md5", + "sha1", + "sha256" + ], + "example": "md5", + "type": "string", + "x-enum-varnames": [ + "MD5", + "SHA1", + "SHA256" + ] + }, + "target": { + "description": "Value used by the operator.", + "example": 123456 + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "bodyHash" + ], + "example": "bodyHash", + "type": "string", + "x-enum-varnames": [ + "BODY_HASH" + ] + } + }, + "required": [ + "type", + "operator", + "target" + ], + "type": "object" + }, + { + "description": "An assertion for the `validatesJSONPath` operator.", + "properties": { + "operator": { + "description": "Assertion operator to apply.", + "enum": [ + "validatesJSONPath" + ], + "example": "validatesJSONPath", + "type": "string", + "x-enum-varnames": [ + "VALIDATES_JSON_PATH" + ] + }, + "property": { + "description": "The associated assertion property.", + "type": "string" + }, + "target": { + "description": "Composed target for `validatesJSONPath` operator.", + "properties": { + "elementsOperator": { + "description": "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`.", + "type": "string" + }, + "jsonPath": { + "description": "The JSON path to assert.", + "type": "string" + }, + "operator": { + "description": "The specific operator to use on the path.", + "type": "string" + }, + "targetValue": { + "description": "The path target value to compare to." + } + }, + "type": "object" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "body", + "header", + "statusCode", + "certificate", + "responseTime", + "property", + "recordEvery", + "recordSome", + "tlsVersion", + "minTlsVersion", + "latency", + "packetLossPercentage", + "packetsReceived", + "networkHop", + "receivedMessage", + "grpcHealthcheckStatus", + "grpcMetadata", + "grpcProto", + "connection" + ], + "example": "statusCode", + "type": "string", + "x-enum-varnames": [ + "BODY", + "HEADER", + "STATUS_CODE", + "CERTIFICATE", + "RESPONSE_TIME", + "PROPERTY", + "RECORD_EVERY", + "RECORD_SOME", + "TLS_VERSION", + "MIN_TLS_VERSION", + "LATENCY", + "PACKET_LOSS_PERCENTAGE", + "PACKETS_RECEIVED", + "NETWORK_HOP", + "RECEIVED_MESSAGE", + "GRPC_HEALTHCHECK_STATUS", + "GRPC_METADATA", + "GRPC_PROTO", + "CONNECTION" + ] + } + }, + "required": [ + "type", + "operator" + ], + "type": "object" + }, + { + "description": "An assertion for the `validatesJSONSchema` operator.", + "properties": { + "operator": { + "description": "Assertion operator to apply.", + "enum": [ + "validatesJSONSchema" + ], + "example": "validatesJSONSchema", + "type": "string", + "x-enum-varnames": [ + "VALIDATES_JSON_SCHEMA" + ] + }, + "target": { + "description": "Composed target for `validatesJSONSchema` operator.", + "properties": { + "jsonSchema": { + "description": "The JSON Schema to assert.", + "type": "string" + }, + "metaSchema": { + "description": "The JSON Schema meta-schema version used in the assertion.", + "enum": [ + "draft-07", + "draft-06" + ], + "type": "string", + "x-enum-varnames": [ + "DRAFT_07", + "DRAFT_06" + ] + } + }, + "type": "object" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "body", + "header", + "statusCode", + "certificate", + "responseTime", + "property", + "recordEvery", + "recordSome", + "tlsVersion", + "minTlsVersion", + "latency", + "packetLossPercentage", + "packetsReceived", + "networkHop", + "receivedMessage", + "grpcHealthcheckStatus", + "grpcMetadata", + "grpcProto", + "connection" + ], + "example": "statusCode", + "type": "string", + "x-enum-varnames": [ + "BODY", + "HEADER", + "STATUS_CODE", + "CERTIFICATE", + "RESPONSE_TIME", + "PROPERTY", + "RECORD_EVERY", + "RECORD_SOME", + "TLS_VERSION", + "MIN_TLS_VERSION", + "LATENCY", + "PACKET_LOSS_PERCENTAGE", + "PACKETS_RECEIVED", + "NETWORK_HOP", + "RECEIVED_MESSAGE", + "GRPC_HEALTHCHECK_STATUS", + "GRPC_METADATA", + "GRPC_PROTO", + "CONNECTION" + ] + } + }, + "required": [ + "type", + "operator" ], "type": "object" }, { - "description": "An assertion for the `validatesJSONPath` operator.", + "description": "An assertion for the `validatesXPath` operator.", "properties": { "operator": { "description": "Assertion operator to apply.", "enum": [ - "validatesJSONPath" + "validatesXPath" ], - "example": "validatesJSONPath", + "example": "validatesXPath", "type": "string", "x-enum-varnames": [ - "VALIDATES_JSON_PATH" + "VALIDATES_X_PATH" ] }, "property": { @@ -1095714,112 +1096896,18 @@ "type": "string" }, "target": { - "description": "Composed target for `validatesJSONPath` operator.", + "description": "Composed target for `validatesXPath` operator.", "properties": { - "elementsOperator": { - "description": "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`.", - "type": "string" - }, - "jsonPath": { - "description": "The JSON path to assert.", - "type": "string" - }, "operator": { "description": "The specific operator to use on the path.", "type": "string" }, "targetValue": { "description": "The path target value to compare to." - } - }, - "type": "object" - }, - "type": { - "description": "Type of the assertion.", - "enum": [ - "body", - "header", - "statusCode", - "certificate", - "responseTime", - "property", - "recordEvery", - "recordSome", - "tlsVersion", - "minTlsVersion", - "latency", - "packetLossPercentage", - "packetsReceived", - "networkHop", - "receivedMessage", - "grpcHealthcheckStatus", - "grpcMetadata", - "grpcProto", - "connection" - ], - "example": "statusCode", - "type": "string", - "x-enum-varnames": [ - "BODY", - "HEADER", - "STATUS_CODE", - "CERTIFICATE", - "RESPONSE_TIME", - "PROPERTY", - "RECORD_EVERY", - "RECORD_SOME", - "TLS_VERSION", - "MIN_TLS_VERSION", - "LATENCY", - "PACKET_LOSS_PERCENTAGE", - "PACKETS_RECEIVED", - "NETWORK_HOP", - "RECEIVED_MESSAGE", - "GRPC_HEALTHCHECK_STATUS", - "GRPC_METADATA", - "GRPC_PROTO", - "CONNECTION" - ] - } - }, - "required": [ - "type", - "operator" - ], - "type": "object" - }, - { - "description": "An assertion for the `validatesJSONSchema` operator.", - "properties": { - "operator": { - "description": "Assertion operator to apply.", - "enum": [ - "validatesJSONSchema" - ], - "example": "validatesJSONSchema", - "type": "string", - "x-enum-varnames": [ - "VALIDATES_JSON_SCHEMA" - ] - }, - "target": { - "description": "Composed target for `validatesJSONSchema` operator.", - "properties": { - "jsonSchema": { - "description": "The JSON Schema to assert.", - "type": "string" }, - "metaSchema": { - "description": "The JSON Schema meta-schema version used in the assertion.", - "enum": [ - "draft-07", - "draft-06" - ], - "type": "string", - "x-enum-varnames": [ - "DRAFT_07", - "DRAFT_06" - ] + "xPath": { + "description": "The X path to assert.", + "type": "string" } }, "type": "object" @@ -1095879,91 +1096967,28 @@ "type": "object" }, { - "description": "An assertion for the `validatesXPath` operator.", + "description": "A JavaScript assertion.", "properties": { - "operator": { - "description": "Assertion operator to apply.", - "enum": [ - "validatesXPath" - ], - "example": "validatesXPath", - "type": "string", - "x-enum-varnames": [ - "VALIDATES_X_PATH" - ] - }, - "property": { - "description": "The associated assertion property.", + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", "type": "string" }, - "target": { - "description": "Composed target for `validatesXPath` operator.", - "properties": { - "operator": { - "description": "The specific operator to use on the path.", - "type": "string" - }, - "targetValue": { - "description": "The path target value to compare to." - }, - "xPath": { - "description": "The X path to assert.", - "type": "string" - } - }, - "type": "object" - }, "type": { "description": "Type of the assertion.", "enum": [ - "body", - "header", - "statusCode", - "certificate", - "responseTime", - "property", - "recordEvery", - "recordSome", - "tlsVersion", - "minTlsVersion", - "latency", - "packetLossPercentage", - "packetsReceived", - "networkHop", - "receivedMessage", - "grpcHealthcheckStatus", - "grpcMetadata", - "grpcProto", - "connection" + "javascript" ], - "example": "statusCode", + "example": "javascript", "type": "string", "x-enum-varnames": [ - "BODY", - "HEADER", - "STATUS_CODE", - "CERTIFICATE", - "RESPONSE_TIME", - "PROPERTY", - "RECORD_EVERY", - "RECORD_SOME", - "TLS_VERSION", - "MIN_TLS_VERSION", - "LATENCY", - "PACKET_LOSS_PERCENTAGE", - "PACKETS_RECEIVED", - "NETWORK_HOP", - "RECEIVED_MESSAGE", - "GRPC_HEALTHCHECK_STATUS", - "GRPC_METADATA", - "GRPC_PROTO", - "CONNECTION" + "JAVASCRIPT" ] } }, "required": [ "type", - "operator" + "code" ], "type": "object" } @@ -1097588,6 +1098613,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1099643,6 +1100694,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, diff --git a/static/resources/json/full_spec_v1.json b/static/resources/json/full_spec_v1.json index f7e60644219da..13fba83f88ea9 100644 --- a/static/resources/json/full_spec_v1.json +++ b/static/resources/json/full_spec_v1.json @@ -485807,6 +485807,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -487014,6 +487040,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -488102,6 +488154,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -489697,6 +489775,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -490785,6 +490889,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -492276,6 +492406,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -493741,6 +493897,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -495043,6 +495225,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -496386,6 +496594,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -496716,6 +496950,43 @@ }, "type": "object" }, + "SyntheticsAssertionJavascript": { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" + }, + "SyntheticsAssertionJavascriptType": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + }, "SyntheticsAssertionOperator": { "description": "Assertion operator to apply.", "enum": [ @@ -498694,6 +498965,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -500278,6 +500575,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -502046,6 +502369,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -503686,6 +504035,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -507539,6 +507914,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -510394,6 +510795,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -511527,6 +511954,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1061554,6 +1062007,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1063293,6 +1063772,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1064915,6 +1065420,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1066861,6 +1067392,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1067949,6 +1068506,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1069556,6 +1070139,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1070644,6 +1071253,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1072436,6 +1073071,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1073524,6 +1074185,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1075248,6 +1075935,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1076336,6 +1077049,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1077626,64 +1078365,247 @@ }, "required": [ "type", - "operator", - "target" - ], - "type": "object" - }, - { - "description": "An assertion which targets body hash.", - "properties": { - "operator": { - "description": "Assertion operator to apply.", - "enum": [ - "md5", - "sha1", - "sha256" - ], - "example": "md5", - "type": "string", - "x-enum-varnames": [ - "MD5", - "SHA1", - "SHA256" - ] - }, - "target": { - "description": "Value used by the operator.", - "example": 123456 - }, - "type": { - "description": "Type of the assertion.", - "enum": [ - "bodyHash" - ], - "example": "bodyHash", - "type": "string", - "x-enum-varnames": [ - "BODY_HASH" - ] - } - }, - "required": [ - "type", - "operator", - "target" + "operator", + "target" + ], + "type": "object" + }, + { + "description": "An assertion which targets body hash.", + "properties": { + "operator": { + "description": "Assertion operator to apply.", + "enum": [ + "md5", + "sha1", + "sha256" + ], + "example": "md5", + "type": "string", + "x-enum-varnames": [ + "MD5", + "SHA1", + "SHA256" + ] + }, + "target": { + "description": "Value used by the operator.", + "example": 123456 + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "bodyHash" + ], + "example": "bodyHash", + "type": "string", + "x-enum-varnames": [ + "BODY_HASH" + ] + } + }, + "required": [ + "type", + "operator", + "target" + ], + "type": "object" + }, + { + "description": "An assertion for the `validatesJSONPath` operator.", + "properties": { + "operator": { + "description": "Assertion operator to apply.", + "enum": [ + "validatesJSONPath" + ], + "example": "validatesJSONPath", + "type": "string", + "x-enum-varnames": [ + "VALIDATES_JSON_PATH" + ] + }, + "property": { + "description": "The associated assertion property.", + "type": "string" + }, + "target": { + "description": "Composed target for `validatesJSONPath` operator.", + "properties": { + "elementsOperator": { + "description": "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`.", + "type": "string" + }, + "jsonPath": { + "description": "The JSON path to assert.", + "type": "string" + }, + "operator": { + "description": "The specific operator to use on the path.", + "type": "string" + }, + "targetValue": { + "description": "The path target value to compare to." + } + }, + "type": "object" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "body", + "header", + "statusCode", + "certificate", + "responseTime", + "property", + "recordEvery", + "recordSome", + "tlsVersion", + "minTlsVersion", + "latency", + "packetLossPercentage", + "packetsReceived", + "networkHop", + "receivedMessage", + "grpcHealthcheckStatus", + "grpcMetadata", + "grpcProto", + "connection" + ], + "example": "statusCode", + "type": "string", + "x-enum-varnames": [ + "BODY", + "HEADER", + "STATUS_CODE", + "CERTIFICATE", + "RESPONSE_TIME", + "PROPERTY", + "RECORD_EVERY", + "RECORD_SOME", + "TLS_VERSION", + "MIN_TLS_VERSION", + "LATENCY", + "PACKET_LOSS_PERCENTAGE", + "PACKETS_RECEIVED", + "NETWORK_HOP", + "RECEIVED_MESSAGE", + "GRPC_HEALTHCHECK_STATUS", + "GRPC_METADATA", + "GRPC_PROTO", + "CONNECTION" + ] + } + }, + "required": [ + "type", + "operator" + ], + "type": "object" + }, + { + "description": "An assertion for the `validatesJSONSchema` operator.", + "properties": { + "operator": { + "description": "Assertion operator to apply.", + "enum": [ + "validatesJSONSchema" + ], + "example": "validatesJSONSchema", + "type": "string", + "x-enum-varnames": [ + "VALIDATES_JSON_SCHEMA" + ] + }, + "target": { + "description": "Composed target for `validatesJSONSchema` operator.", + "properties": { + "jsonSchema": { + "description": "The JSON Schema to assert.", + "type": "string" + }, + "metaSchema": { + "description": "The JSON Schema meta-schema version used in the assertion.", + "enum": [ + "draft-07", + "draft-06" + ], + "type": "string", + "x-enum-varnames": [ + "DRAFT_07", + "DRAFT_06" + ] + } + }, + "type": "object" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "body", + "header", + "statusCode", + "certificate", + "responseTime", + "property", + "recordEvery", + "recordSome", + "tlsVersion", + "minTlsVersion", + "latency", + "packetLossPercentage", + "packetsReceived", + "networkHop", + "receivedMessage", + "grpcHealthcheckStatus", + "grpcMetadata", + "grpcProto", + "connection" + ], + "example": "statusCode", + "type": "string", + "x-enum-varnames": [ + "BODY", + "HEADER", + "STATUS_CODE", + "CERTIFICATE", + "RESPONSE_TIME", + "PROPERTY", + "RECORD_EVERY", + "RECORD_SOME", + "TLS_VERSION", + "MIN_TLS_VERSION", + "LATENCY", + "PACKET_LOSS_PERCENTAGE", + "PACKETS_RECEIVED", + "NETWORK_HOP", + "RECEIVED_MESSAGE", + "GRPC_HEALTHCHECK_STATUS", + "GRPC_METADATA", + "GRPC_PROTO", + "CONNECTION" + ] + } + }, + "required": [ + "type", + "operator" ], "type": "object" }, { - "description": "An assertion for the `validatesJSONPath` operator.", + "description": "An assertion for the `validatesXPath` operator.", "properties": { "operator": { "description": "Assertion operator to apply.", "enum": [ - "validatesJSONPath" + "validatesXPath" ], - "example": "validatesJSONPath", + "example": "validatesXPath", "type": "string", "x-enum-varnames": [ - "VALIDATES_JSON_PATH" + "VALIDATES_X_PATH" ] }, "property": { @@ -1077691,112 +1078613,18 @@ "type": "string" }, "target": { - "description": "Composed target for `validatesJSONPath` operator.", + "description": "Composed target for `validatesXPath` operator.", "properties": { - "elementsOperator": { - "description": "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`.", - "type": "string" - }, - "jsonPath": { - "description": "The JSON path to assert.", - "type": "string" - }, "operator": { "description": "The specific operator to use on the path.", "type": "string" }, "targetValue": { "description": "The path target value to compare to." - } - }, - "type": "object" - }, - "type": { - "description": "Type of the assertion.", - "enum": [ - "body", - "header", - "statusCode", - "certificate", - "responseTime", - "property", - "recordEvery", - "recordSome", - "tlsVersion", - "minTlsVersion", - "latency", - "packetLossPercentage", - "packetsReceived", - "networkHop", - "receivedMessage", - "grpcHealthcheckStatus", - "grpcMetadata", - "grpcProto", - "connection" - ], - "example": "statusCode", - "type": "string", - "x-enum-varnames": [ - "BODY", - "HEADER", - "STATUS_CODE", - "CERTIFICATE", - "RESPONSE_TIME", - "PROPERTY", - "RECORD_EVERY", - "RECORD_SOME", - "TLS_VERSION", - "MIN_TLS_VERSION", - "LATENCY", - "PACKET_LOSS_PERCENTAGE", - "PACKETS_RECEIVED", - "NETWORK_HOP", - "RECEIVED_MESSAGE", - "GRPC_HEALTHCHECK_STATUS", - "GRPC_METADATA", - "GRPC_PROTO", - "CONNECTION" - ] - } - }, - "required": [ - "type", - "operator" - ], - "type": "object" - }, - { - "description": "An assertion for the `validatesJSONSchema` operator.", - "properties": { - "operator": { - "description": "Assertion operator to apply.", - "enum": [ - "validatesJSONSchema" - ], - "example": "validatesJSONSchema", - "type": "string", - "x-enum-varnames": [ - "VALIDATES_JSON_SCHEMA" - ] - }, - "target": { - "description": "Composed target for `validatesJSONSchema` operator.", - "properties": { - "jsonSchema": { - "description": "The JSON Schema to assert.", - "type": "string" }, - "metaSchema": { - "description": "The JSON Schema meta-schema version used in the assertion.", - "enum": [ - "draft-07", - "draft-06" - ], - "type": "string", - "x-enum-varnames": [ - "DRAFT_07", - "DRAFT_06" - ] + "xPath": { + "description": "The X path to assert.", + "type": "string" } }, "type": "object" @@ -1077856,91 +1078684,28 @@ "type": "object" }, { - "description": "An assertion for the `validatesXPath` operator.", + "description": "A JavaScript assertion.", "properties": { - "operator": { - "description": "Assertion operator to apply.", - "enum": [ - "validatesXPath" - ], - "example": "validatesXPath", - "type": "string", - "x-enum-varnames": [ - "VALIDATES_X_PATH" - ] - }, - "property": { - "description": "The associated assertion property.", + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", "type": "string" }, - "target": { - "description": "Composed target for `validatesXPath` operator.", - "properties": { - "operator": { - "description": "The specific operator to use on the path.", - "type": "string" - }, - "targetValue": { - "description": "The path target value to compare to." - }, - "xPath": { - "description": "The X path to assert.", - "type": "string" - } - }, - "type": "object" - }, "type": { "description": "Type of the assertion.", "enum": [ - "body", - "header", - "statusCode", - "certificate", - "responseTime", - "property", - "recordEvery", - "recordSome", - "tlsVersion", - "minTlsVersion", - "latency", - "packetLossPercentage", - "packetsReceived", - "networkHop", - "receivedMessage", - "grpcHealthcheckStatus", - "grpcMetadata", - "grpcProto", - "connection" + "javascript" ], - "example": "statusCode", + "example": "javascript", "type": "string", "x-enum-varnames": [ - "BODY", - "HEADER", - "STATUS_CODE", - "CERTIFICATE", - "RESPONSE_TIME", - "PROPERTY", - "RECORD_EVERY", - "RECORD_SOME", - "TLS_VERSION", - "MIN_TLS_VERSION", - "LATENCY", - "PACKET_LOSS_PERCENTAGE", - "PACKETS_RECEIVED", - "NETWORK_HOP", - "RECEIVED_MESSAGE", - "GRPC_HEALTHCHECK_STATUS", - "GRPC_METADATA", - "GRPC_PROTO", - "CONNECTION" + "JAVASCRIPT" ] } }, "required": [ "type", - "operator" + "code" ], "type": "object" } @@ -1079031,6 +1079796,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1080756,6 +1081547,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1082352,6 +1083169,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1084104,6 +1084947,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1085500,64 +1086369,247 @@ }, "required": [ "type", - "operator", - "target" - ], - "type": "object" - }, - { - "description": "An assertion which targets body hash.", - "properties": { - "operator": { - "description": "Assertion operator to apply.", - "enum": [ - "md5", - "sha1", - "sha256" - ], - "example": "md5", - "type": "string", - "x-enum-varnames": [ - "MD5", - "SHA1", - "SHA256" - ] - }, - "target": { - "description": "Value used by the operator.", - "example": 123456 - }, - "type": { - "description": "Type of the assertion.", - "enum": [ - "bodyHash" - ], - "example": "bodyHash", - "type": "string", - "x-enum-varnames": [ - "BODY_HASH" - ] - } - }, - "required": [ - "type", - "operator", - "target" + "operator", + "target" + ], + "type": "object" + }, + { + "description": "An assertion which targets body hash.", + "properties": { + "operator": { + "description": "Assertion operator to apply.", + "enum": [ + "md5", + "sha1", + "sha256" + ], + "example": "md5", + "type": "string", + "x-enum-varnames": [ + "MD5", + "SHA1", + "SHA256" + ] + }, + "target": { + "description": "Value used by the operator.", + "example": 123456 + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "bodyHash" + ], + "example": "bodyHash", + "type": "string", + "x-enum-varnames": [ + "BODY_HASH" + ] + } + }, + "required": [ + "type", + "operator", + "target" + ], + "type": "object" + }, + { + "description": "An assertion for the `validatesJSONPath` operator.", + "properties": { + "operator": { + "description": "Assertion operator to apply.", + "enum": [ + "validatesJSONPath" + ], + "example": "validatesJSONPath", + "type": "string", + "x-enum-varnames": [ + "VALIDATES_JSON_PATH" + ] + }, + "property": { + "description": "The associated assertion property.", + "type": "string" + }, + "target": { + "description": "Composed target for `validatesJSONPath` operator.", + "properties": { + "elementsOperator": { + "description": "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`.", + "type": "string" + }, + "jsonPath": { + "description": "The JSON path to assert.", + "type": "string" + }, + "operator": { + "description": "The specific operator to use on the path.", + "type": "string" + }, + "targetValue": { + "description": "The path target value to compare to." + } + }, + "type": "object" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "body", + "header", + "statusCode", + "certificate", + "responseTime", + "property", + "recordEvery", + "recordSome", + "tlsVersion", + "minTlsVersion", + "latency", + "packetLossPercentage", + "packetsReceived", + "networkHop", + "receivedMessage", + "grpcHealthcheckStatus", + "grpcMetadata", + "grpcProto", + "connection" + ], + "example": "statusCode", + "type": "string", + "x-enum-varnames": [ + "BODY", + "HEADER", + "STATUS_CODE", + "CERTIFICATE", + "RESPONSE_TIME", + "PROPERTY", + "RECORD_EVERY", + "RECORD_SOME", + "TLS_VERSION", + "MIN_TLS_VERSION", + "LATENCY", + "PACKET_LOSS_PERCENTAGE", + "PACKETS_RECEIVED", + "NETWORK_HOP", + "RECEIVED_MESSAGE", + "GRPC_HEALTHCHECK_STATUS", + "GRPC_METADATA", + "GRPC_PROTO", + "CONNECTION" + ] + } + }, + "required": [ + "type", + "operator" + ], + "type": "object" + }, + { + "description": "An assertion for the `validatesJSONSchema` operator.", + "properties": { + "operator": { + "description": "Assertion operator to apply.", + "enum": [ + "validatesJSONSchema" + ], + "example": "validatesJSONSchema", + "type": "string", + "x-enum-varnames": [ + "VALIDATES_JSON_SCHEMA" + ] + }, + "target": { + "description": "Composed target for `validatesJSONSchema` operator.", + "properties": { + "jsonSchema": { + "description": "The JSON Schema to assert.", + "type": "string" + }, + "metaSchema": { + "description": "The JSON Schema meta-schema version used in the assertion.", + "enum": [ + "draft-07", + "draft-06" + ], + "type": "string", + "x-enum-varnames": [ + "DRAFT_07", + "DRAFT_06" + ] + } + }, + "type": "object" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "body", + "header", + "statusCode", + "certificate", + "responseTime", + "property", + "recordEvery", + "recordSome", + "tlsVersion", + "minTlsVersion", + "latency", + "packetLossPercentage", + "packetsReceived", + "networkHop", + "receivedMessage", + "grpcHealthcheckStatus", + "grpcMetadata", + "grpcProto", + "connection" + ], + "example": "statusCode", + "type": "string", + "x-enum-varnames": [ + "BODY", + "HEADER", + "STATUS_CODE", + "CERTIFICATE", + "RESPONSE_TIME", + "PROPERTY", + "RECORD_EVERY", + "RECORD_SOME", + "TLS_VERSION", + "MIN_TLS_VERSION", + "LATENCY", + "PACKET_LOSS_PERCENTAGE", + "PACKETS_RECEIVED", + "NETWORK_HOP", + "RECEIVED_MESSAGE", + "GRPC_HEALTHCHECK_STATUS", + "GRPC_METADATA", + "GRPC_PROTO", + "CONNECTION" + ] + } + }, + "required": [ + "type", + "operator" ], "type": "object" }, { - "description": "An assertion for the `validatesJSONPath` operator.", + "description": "An assertion for the `validatesXPath` operator.", "properties": { "operator": { "description": "Assertion operator to apply.", "enum": [ - "validatesJSONPath" + "validatesXPath" ], - "example": "validatesJSONPath", + "example": "validatesXPath", "type": "string", "x-enum-varnames": [ - "VALIDATES_JSON_PATH" + "VALIDATES_X_PATH" ] }, "property": { @@ -1085565,112 +1086617,18 @@ "type": "string" }, "target": { - "description": "Composed target for `validatesJSONPath` operator.", + "description": "Composed target for `validatesXPath` operator.", "properties": { - "elementsOperator": { - "description": "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`.", - "type": "string" - }, - "jsonPath": { - "description": "The JSON path to assert.", - "type": "string" - }, "operator": { "description": "The specific operator to use on the path.", "type": "string" }, "targetValue": { "description": "The path target value to compare to." - } - }, - "type": "object" - }, - "type": { - "description": "Type of the assertion.", - "enum": [ - "body", - "header", - "statusCode", - "certificate", - "responseTime", - "property", - "recordEvery", - "recordSome", - "tlsVersion", - "minTlsVersion", - "latency", - "packetLossPercentage", - "packetsReceived", - "networkHop", - "receivedMessage", - "grpcHealthcheckStatus", - "grpcMetadata", - "grpcProto", - "connection" - ], - "example": "statusCode", - "type": "string", - "x-enum-varnames": [ - "BODY", - "HEADER", - "STATUS_CODE", - "CERTIFICATE", - "RESPONSE_TIME", - "PROPERTY", - "RECORD_EVERY", - "RECORD_SOME", - "TLS_VERSION", - "MIN_TLS_VERSION", - "LATENCY", - "PACKET_LOSS_PERCENTAGE", - "PACKETS_RECEIVED", - "NETWORK_HOP", - "RECEIVED_MESSAGE", - "GRPC_HEALTHCHECK_STATUS", - "GRPC_METADATA", - "GRPC_PROTO", - "CONNECTION" - ] - } - }, - "required": [ - "type", - "operator" - ], - "type": "object" - }, - { - "description": "An assertion for the `validatesJSONSchema` operator.", - "properties": { - "operator": { - "description": "Assertion operator to apply.", - "enum": [ - "validatesJSONSchema" - ], - "example": "validatesJSONSchema", - "type": "string", - "x-enum-varnames": [ - "VALIDATES_JSON_SCHEMA" - ] - }, - "target": { - "description": "Composed target for `validatesJSONSchema` operator.", - "properties": { - "jsonSchema": { - "description": "The JSON Schema to assert.", - "type": "string" }, - "metaSchema": { - "description": "The JSON Schema meta-schema version used in the assertion.", - "enum": [ - "draft-07", - "draft-06" - ], - "type": "string", - "x-enum-varnames": [ - "DRAFT_07", - "DRAFT_06" - ] + "xPath": { + "description": "The X path to assert.", + "type": "string" } }, "type": "object" @@ -1085730,91 +1086688,28 @@ "type": "object" }, { - "description": "An assertion for the `validatesXPath` operator.", + "description": "A JavaScript assertion.", "properties": { - "operator": { - "description": "Assertion operator to apply.", - "enum": [ - "validatesXPath" - ], - "example": "validatesXPath", - "type": "string", - "x-enum-varnames": [ - "VALIDATES_X_PATH" - ] - }, - "property": { - "description": "The associated assertion property.", + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", "type": "string" }, - "target": { - "description": "Composed target for `validatesXPath` operator.", - "properties": { - "operator": { - "description": "The specific operator to use on the path.", - "type": "string" - }, - "targetValue": { - "description": "The path target value to compare to." - }, - "xPath": { - "description": "The X path to assert.", - "type": "string" - } - }, - "type": "object" - }, "type": { "description": "Type of the assertion.", "enum": [ - "body", - "header", - "statusCode", - "certificate", - "responseTime", - "property", - "recordEvery", - "recordSome", - "tlsVersion", - "minTlsVersion", - "latency", - "packetLossPercentage", - "packetsReceived", - "networkHop", - "receivedMessage", - "grpcHealthcheckStatus", - "grpcMetadata", - "grpcProto", - "connection" + "javascript" ], - "example": "statusCode", + "example": "javascript", "type": "string", "x-enum-varnames": [ - "BODY", - "HEADER", - "STATUS_CODE", - "CERTIFICATE", - "RESPONSE_TIME", - "PROPERTY", - "RECORD_EVERY", - "RECORD_SOME", - "TLS_VERSION", - "MIN_TLS_VERSION", - "LATENCY", - "PACKET_LOSS_PERCENTAGE", - "PACKETS_RECEIVED", - "NETWORK_HOP", - "RECEIVED_MESSAGE", - "GRPC_HEALTHCHECK_STATUS", - "GRPC_METADATA", - "GRPC_PROTO", - "CONNECTION" + "JAVASCRIPT" ] } }, "required": [ "type", - "operator" + "code" ], "type": "object" } @@ -1087413,6 +1088308,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1089473,6 +1090394,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1092392,6 +1093339,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1094197,6 +1095170,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1095649,64 +1096648,247 @@ }, "required": [ "type", - "operator", - "target" - ], - "type": "object" - }, - { - "description": "An assertion which targets body hash.", - "properties": { - "operator": { - "description": "Assertion operator to apply.", - "enum": [ - "md5", - "sha1", - "sha256" - ], - "example": "md5", - "type": "string", - "x-enum-varnames": [ - "MD5", - "SHA1", - "SHA256" - ] - }, - "target": { - "description": "Value used by the operator.", - "example": 123456 - }, - "type": { - "description": "Type of the assertion.", - "enum": [ - "bodyHash" - ], - "example": "bodyHash", - "type": "string", - "x-enum-varnames": [ - "BODY_HASH" - ] - } - }, - "required": [ - "type", - "operator", - "target" + "operator", + "target" + ], + "type": "object" + }, + { + "description": "An assertion which targets body hash.", + "properties": { + "operator": { + "description": "Assertion operator to apply.", + "enum": [ + "md5", + "sha1", + "sha256" + ], + "example": "md5", + "type": "string", + "x-enum-varnames": [ + "MD5", + "SHA1", + "SHA256" + ] + }, + "target": { + "description": "Value used by the operator.", + "example": 123456 + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "bodyHash" + ], + "example": "bodyHash", + "type": "string", + "x-enum-varnames": [ + "BODY_HASH" + ] + } + }, + "required": [ + "type", + "operator", + "target" + ], + "type": "object" + }, + { + "description": "An assertion for the `validatesJSONPath` operator.", + "properties": { + "operator": { + "description": "Assertion operator to apply.", + "enum": [ + "validatesJSONPath" + ], + "example": "validatesJSONPath", + "type": "string", + "x-enum-varnames": [ + "VALIDATES_JSON_PATH" + ] + }, + "property": { + "description": "The associated assertion property.", + "type": "string" + }, + "target": { + "description": "Composed target for `validatesJSONPath` operator.", + "properties": { + "elementsOperator": { + "description": "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`.", + "type": "string" + }, + "jsonPath": { + "description": "The JSON path to assert.", + "type": "string" + }, + "operator": { + "description": "The specific operator to use on the path.", + "type": "string" + }, + "targetValue": { + "description": "The path target value to compare to." + } + }, + "type": "object" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "body", + "header", + "statusCode", + "certificate", + "responseTime", + "property", + "recordEvery", + "recordSome", + "tlsVersion", + "minTlsVersion", + "latency", + "packetLossPercentage", + "packetsReceived", + "networkHop", + "receivedMessage", + "grpcHealthcheckStatus", + "grpcMetadata", + "grpcProto", + "connection" + ], + "example": "statusCode", + "type": "string", + "x-enum-varnames": [ + "BODY", + "HEADER", + "STATUS_CODE", + "CERTIFICATE", + "RESPONSE_TIME", + "PROPERTY", + "RECORD_EVERY", + "RECORD_SOME", + "TLS_VERSION", + "MIN_TLS_VERSION", + "LATENCY", + "PACKET_LOSS_PERCENTAGE", + "PACKETS_RECEIVED", + "NETWORK_HOP", + "RECEIVED_MESSAGE", + "GRPC_HEALTHCHECK_STATUS", + "GRPC_METADATA", + "GRPC_PROTO", + "CONNECTION" + ] + } + }, + "required": [ + "type", + "operator" + ], + "type": "object" + }, + { + "description": "An assertion for the `validatesJSONSchema` operator.", + "properties": { + "operator": { + "description": "Assertion operator to apply.", + "enum": [ + "validatesJSONSchema" + ], + "example": "validatesJSONSchema", + "type": "string", + "x-enum-varnames": [ + "VALIDATES_JSON_SCHEMA" + ] + }, + "target": { + "description": "Composed target for `validatesJSONSchema` operator.", + "properties": { + "jsonSchema": { + "description": "The JSON Schema to assert.", + "type": "string" + }, + "metaSchema": { + "description": "The JSON Schema meta-schema version used in the assertion.", + "enum": [ + "draft-07", + "draft-06" + ], + "type": "string", + "x-enum-varnames": [ + "DRAFT_07", + "DRAFT_06" + ] + } + }, + "type": "object" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "body", + "header", + "statusCode", + "certificate", + "responseTime", + "property", + "recordEvery", + "recordSome", + "tlsVersion", + "minTlsVersion", + "latency", + "packetLossPercentage", + "packetsReceived", + "networkHop", + "receivedMessage", + "grpcHealthcheckStatus", + "grpcMetadata", + "grpcProto", + "connection" + ], + "example": "statusCode", + "type": "string", + "x-enum-varnames": [ + "BODY", + "HEADER", + "STATUS_CODE", + "CERTIFICATE", + "RESPONSE_TIME", + "PROPERTY", + "RECORD_EVERY", + "RECORD_SOME", + "TLS_VERSION", + "MIN_TLS_VERSION", + "LATENCY", + "PACKET_LOSS_PERCENTAGE", + "PACKETS_RECEIVED", + "NETWORK_HOP", + "RECEIVED_MESSAGE", + "GRPC_HEALTHCHECK_STATUS", + "GRPC_METADATA", + "GRPC_PROTO", + "CONNECTION" + ] + } + }, + "required": [ + "type", + "operator" ], "type": "object" }, { - "description": "An assertion for the `validatesJSONPath` operator.", + "description": "An assertion for the `validatesXPath` operator.", "properties": { "operator": { "description": "Assertion operator to apply.", "enum": [ - "validatesJSONPath" + "validatesXPath" ], - "example": "validatesJSONPath", + "example": "validatesXPath", "type": "string", "x-enum-varnames": [ - "VALIDATES_JSON_PATH" + "VALIDATES_X_PATH" ] }, "property": { @@ -1095714,112 +1096896,18 @@ "type": "string" }, "target": { - "description": "Composed target for `validatesJSONPath` operator.", + "description": "Composed target for `validatesXPath` operator.", "properties": { - "elementsOperator": { - "description": "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`.", - "type": "string" - }, - "jsonPath": { - "description": "The JSON path to assert.", - "type": "string" - }, "operator": { "description": "The specific operator to use on the path.", "type": "string" }, "targetValue": { "description": "The path target value to compare to." - } - }, - "type": "object" - }, - "type": { - "description": "Type of the assertion.", - "enum": [ - "body", - "header", - "statusCode", - "certificate", - "responseTime", - "property", - "recordEvery", - "recordSome", - "tlsVersion", - "minTlsVersion", - "latency", - "packetLossPercentage", - "packetsReceived", - "networkHop", - "receivedMessage", - "grpcHealthcheckStatus", - "grpcMetadata", - "grpcProto", - "connection" - ], - "example": "statusCode", - "type": "string", - "x-enum-varnames": [ - "BODY", - "HEADER", - "STATUS_CODE", - "CERTIFICATE", - "RESPONSE_TIME", - "PROPERTY", - "RECORD_EVERY", - "RECORD_SOME", - "TLS_VERSION", - "MIN_TLS_VERSION", - "LATENCY", - "PACKET_LOSS_PERCENTAGE", - "PACKETS_RECEIVED", - "NETWORK_HOP", - "RECEIVED_MESSAGE", - "GRPC_HEALTHCHECK_STATUS", - "GRPC_METADATA", - "GRPC_PROTO", - "CONNECTION" - ] - } - }, - "required": [ - "type", - "operator" - ], - "type": "object" - }, - { - "description": "An assertion for the `validatesJSONSchema` operator.", - "properties": { - "operator": { - "description": "Assertion operator to apply.", - "enum": [ - "validatesJSONSchema" - ], - "example": "validatesJSONSchema", - "type": "string", - "x-enum-varnames": [ - "VALIDATES_JSON_SCHEMA" - ] - }, - "target": { - "description": "Composed target for `validatesJSONSchema` operator.", - "properties": { - "jsonSchema": { - "description": "The JSON Schema to assert.", - "type": "string" }, - "metaSchema": { - "description": "The JSON Schema meta-schema version used in the assertion.", - "enum": [ - "draft-07", - "draft-06" - ], - "type": "string", - "x-enum-varnames": [ - "DRAFT_07", - "DRAFT_06" - ] + "xPath": { + "description": "The X path to assert.", + "type": "string" } }, "type": "object" @@ -1095879,91 +1096967,28 @@ "type": "object" }, { - "description": "An assertion for the `validatesXPath` operator.", + "description": "A JavaScript assertion.", "properties": { - "operator": { - "description": "Assertion operator to apply.", - "enum": [ - "validatesXPath" - ], - "example": "validatesXPath", - "type": "string", - "x-enum-varnames": [ - "VALIDATES_X_PATH" - ] - }, - "property": { - "description": "The associated assertion property.", + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", "type": "string" }, - "target": { - "description": "Composed target for `validatesXPath` operator.", - "properties": { - "operator": { - "description": "The specific operator to use on the path.", - "type": "string" - }, - "targetValue": { - "description": "The path target value to compare to." - }, - "xPath": { - "description": "The X path to assert.", - "type": "string" - } - }, - "type": "object" - }, "type": { "description": "Type of the assertion.", "enum": [ - "body", - "header", - "statusCode", - "certificate", - "responseTime", - "property", - "recordEvery", - "recordSome", - "tlsVersion", - "minTlsVersion", - "latency", - "packetLossPercentage", - "packetsReceived", - "networkHop", - "receivedMessage", - "grpcHealthcheckStatus", - "grpcMetadata", - "grpcProto", - "connection" + "javascript" ], - "example": "statusCode", + "example": "javascript", "type": "string", "x-enum-varnames": [ - "BODY", - "HEADER", - "STATUS_CODE", - "CERTIFICATE", - "RESPONSE_TIME", - "PROPERTY", - "RECORD_EVERY", - "RECORD_SOME", - "TLS_VERSION", - "MIN_TLS_VERSION", - "LATENCY", - "PACKET_LOSS_PERCENTAGE", - "PACKETS_RECEIVED", - "NETWORK_HOP", - "RECEIVED_MESSAGE", - "GRPC_HEALTHCHECK_STATUS", - "GRPC_METADATA", - "GRPC_PROTO", - "CONNECTION" + "JAVASCRIPT" ] } }, "required": [ "type", - "operator" + "code" ], "type": "object" } @@ -1097588,6 +1098613,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] }, @@ -1099643,6 +1100694,32 @@ "operator" ], "type": "object" + }, + { + "description": "A JavaScript assertion.", + "properties": { + "code": { + "description": "The JavaScript code that performs the assertions.", + "example": "dd.expect(dd.response.statusCode).to.equal(200);", + "type": "string" + }, + "type": { + "description": "Type of the assertion.", + "enum": [ + "javascript" + ], + "example": "javascript", + "type": "string", + "x-enum-varnames": [ + "JAVASCRIPT" + ] + } + }, + "required": [ + "type", + "code" + ], + "type": "object" } ] },