diff --git a/.apigentools-info b/.apigentools-info index fb96b12f1252c..d9a6de2bb60a3 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2024-10-25 13:07:12.077590", - "spec_repo_commit": "a2f558e8" + "regenerated": "2024-10-28 10:24:44.676000", + "spec_repo_commit": "2e09a3ec" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2024-10-25 13:07:19.967111", - "spec_repo_commit": "a2f558e8" + "regenerated": "2024-10-28 10:24:52.380008", + "spec_repo_commit": "2e09a3ec" } } } \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 43c5f9d021472..02f517e4482a2 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -6,9 +6,13 @@ ### Merge instructions -- [ ] Please merge after reviewing +Merge queue is enabled in this repo. To have it automatically merged after it receives the required reviews, create the PR (from a branch that follows the `/description` naming convention) and then add the following PR comment: + +``` +/merge +``` ### Additional notes - \ No newline at end of file + diff --git a/config/_default/menus/main.en.yaml b/config/_default/menus/main.en.yaml index 0b3e8cd7928cd..62d55df09b7ce 100644 --- a/config/_default/menus/main.en.yaml +++ b/config/_default/menus/main.en.yaml @@ -5163,7 +5163,7 @@ menu: parent: log_collection identifier: log_collection_java weight: 110 - - name: NodeJS + - name: Node.js identifier: log_collection_nodejs url: logs/log_collection/nodejs/ parent: log_collection diff --git a/config/_default/menus/main.fr.yaml b/config/_default/menus/main.fr.yaml index c390403829c7d..8e4bace52c1ff 100644 --- a/config/_default/menus/main.fr.yaml +++ b/config/_default/menus/main.fr.yaml @@ -4797,7 +4797,7 @@ menu: parent: log_collection identifier: log_collection_java weight: 109 - - name: NodeJS + - name: Node.js identifier: log_collection_nodejs url: logs/log_collection/nodejs/ parent: log_collection diff --git a/config/_default/menus/main.ja.yaml b/config/_default/menus/main.ja.yaml index 0d20639513fe1..f350c1188eaaa 100644 --- a/config/_default/menus/main.ja.yaml +++ b/config/_default/menus/main.ja.yaml @@ -4797,7 +4797,7 @@ menu: parent: log_collection identifier: log_collection_java weight: 109 - - name: NodeJS + - name: Node.js identifier: log_collection_nodejs url: logs/log_collection/nodejs/ parent: log_collection diff --git a/content/en/api/v1/synthetics/examples.json b/content/en/api/v1/synthetics/examples.json index 370f30f1bd73d..269f16aff52f1 100644 --- a/content/en/api/v1/synthetics/examples.json +++ b/content/en/api/v1/synthetics/examples.json @@ -474,7 +474,10 @@ "min_location_failed": "integer", "monitor_name": "string", "monitor_options": { - "renotify_interval": "integer" + "escalation_message": "string", + "notification_preset_name": "string", + "renotify_interval": "integer", + "renotify_occurrences": "integer" }, "monitor_priority": "integer", "noScreenshot": false, @@ -521,7 +524,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

Option 6

\n
\n

object

\n

A JavaScript assertion.

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

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

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

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

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

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

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

example

\n
\n

string

\n

Example for the variable.

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

id

\n
\n

string

\n

ID of the variable for global variables.

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

name [required]

\n
\n

string

\n

Name of the variable.

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

pattern

\n
\n

string

\n

Pattern of the variable.

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

secure

\n
\n

boolean

\n

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

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

type [required]

\n
\n

enum

\n

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

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

request

\n
\n

object

\n

Object describing the Synthetic test request.

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

allow_insecure

\n
\n

boolean

\n

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

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

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

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

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

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

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

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

type

\n
\n

enum

\n

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

default: web

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

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

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

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

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

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

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

region

\n
\n

string

\n

Region for the SIGV4 authentication.

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

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

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

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

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

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

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

type [required]

\n
\n

enum

\n

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

default: sigv4

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

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

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

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

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

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

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

type [required]

\n
\n

enum

\n

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

default: ntlm

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

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

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

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

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

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

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

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

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

type [required]

\n
\n

enum

\n

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

default: digest

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

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

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

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

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

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

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

audience

\n
\n

string

\n

Audience to use when performing the authentication.

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

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

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

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

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

resource

\n
\n

string

\n

Resource to use when performing the authentication.

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

scope

\n
\n

string

\n

Scope to use when performing the authentication.

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

tokenApiAuthentication [required]

\n
\n

enum

\n

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

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

type [required]

\n
\n

enum

\n

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

default: oauth-client

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

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

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

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

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

audience

\n
\n

string

\n

Audience to use when performing the authentication.

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

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

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

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

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

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

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

resource

\n
\n

string

\n

Resource to use when performing the authentication.

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

scope

\n
\n

string

\n

Scope to use when performing the authentication.

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

tokenApiAuthentication [required]

\n
\n

enum

\n

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

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

type [required]

\n
\n

enum

\n

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

default: oauth-rop

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

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

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

body

\n
\n

string

\n

Body to include in the test.

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

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

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

callType

\n
\n

enum

\n

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

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

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

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

cert

\n
\n

object

\n

Define a request certificate.

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

content

\n
\n

string

\n

Content of the certificate or key.

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

filename

\n
\n

string

\n

File name for the certificate or key.

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

updatedAt

\n
\n

string

\n

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

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

key

\n
\n

object

\n

Define a request certificate.

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

content

\n
\n

string

\n

Content of the certificate or key.

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

filename

\n
\n

string

\n

File name for the certificate or key.

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

updatedAt

\n
\n

string

\n

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

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

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

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

compressedJsonDescriptor

\n
\n

string

\n

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

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

compressedProtoFile

\n
\n

string

\n

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

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

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

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

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

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

files

\n
\n

[object]

\n

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

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

bucketKey

\n
\n

string

\n

Bucket key of the file.

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

content

\n
\n

string

\n

Content of the file.

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

name

\n
\n

string

\n

Name of the file.

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

originalFileName

\n
\n

string

\n

Original name of the file.

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

size

\n
\n

int64

\n

Size of the file.

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

type

\n
\n

string

\n

Type of the file.

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

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

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

headers

\n
\n

object

\n

Headers to include when performing the test.

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

<any-key>

\n
\n

string

\n

A single Header.

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

host

\n
\n

string

\n

Host name to perform the test with.

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

httpVersion

\n
\n

enum

\n

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

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

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

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

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

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

<any-key>

\n
\n

string

\n

A single metadatum.

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

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

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

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

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

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

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

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

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

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

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

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

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

Option 2

\n
\n

string

\n

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

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

proxy

\n
\n

object

\n

The proxy to perform the test.

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

headers

\n
\n

object

\n

Headers to include when performing the test.

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

<any-key>

\n
\n

string

\n

A single Header.

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

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

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

query

\n
\n

object

\n

Query to use for the test.

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

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

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

service

\n
\n

string

\n

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

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

shouldTrackHops

\n
\n

boolean

\n

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

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

timeout

\n
\n

double

\n

Timeout in seconds for the test.

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

url

\n
\n

string

\n

URL to perform the test with.

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

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,mobile

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

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

request

\n
\n

object

\n

Object describing the Synthetic test request.

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

allow_insecure

\n
\n

boolean

\n

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

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

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

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

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

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

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

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

type

\n
\n

enum

\n

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

default: web

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

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

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

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

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

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

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

region

\n
\n

string

\n

Region for the SIGV4 authentication.

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

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

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

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

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

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

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

type [required]

\n
\n

enum

\n

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

default: sigv4

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

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

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

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

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

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

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

type [required]

\n
\n

enum

\n

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

default: ntlm

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

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

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

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

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

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

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

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

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

type [required]

\n
\n

enum

\n

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

default: digest

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

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

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

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

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

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

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

audience

\n
\n

string

\n

Audience to use when performing the authentication.

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

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

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

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

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

resource

\n
\n

string

\n

Resource to use when performing the authentication.

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

scope

\n
\n

string

\n

Scope to use when performing the authentication.

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

tokenApiAuthentication [required]

\n
\n

enum

\n

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

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

type [required]

\n
\n

enum

\n

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

default: oauth-client

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

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

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

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

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

audience

\n
\n

string

\n

Audience to use when performing the authentication.

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

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

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

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

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

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

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

resource

\n
\n

string

\n

Resource to use when performing the authentication.

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

scope

\n
\n

string

\n

Scope to use when performing the authentication.

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

tokenApiAuthentication [required]

\n
\n

enum

\n

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

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

type [required]

\n
\n

enum

\n

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

default: oauth-rop

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

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

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

body

\n
\n

string

\n

Body to include in the test.

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

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

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

callType

\n
\n

enum

\n

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

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

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

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

cert

\n
\n

object

\n

Define a request certificate.

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

content

\n
\n

string

\n

Content of the certificate or key.

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

filename

\n
\n

string

\n

File name for the certificate or key.

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

updatedAt

\n
\n

string

\n

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

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

key

\n
\n

object

\n

Define a request certificate.

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

content

\n
\n

string

\n

Content of the certificate or key.

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

filename

\n
\n

string

\n

File name for the certificate or key.

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

updatedAt

\n
\n

string

\n

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

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

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

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

compressedJsonDescriptor

\n
\n

string

\n

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

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

compressedProtoFile

\n
\n

string

\n

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

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

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

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

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

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

files

\n
\n

[object]

\n

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

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

bucketKey

\n
\n

string

\n

Bucket key of the file.

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

content

\n
\n

string

\n

Content of the file.

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

name

\n
\n

string

\n

Name of the file.

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

originalFileName

\n
\n

string

\n

Original name of the file.

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

size

\n
\n

int64

\n

Size of the file.

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

type

\n
\n

string

\n

Type of the file.

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

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

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

headers

\n
\n

object

\n

Headers to include when performing the test.

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

<any-key>

\n
\n

string

\n

A single Header.

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

host

\n
\n

string

\n

Host name to perform the test with.

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

httpVersion

\n
\n

enum

\n

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

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

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

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

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

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

<any-key>

\n
\n

string

\n

A single metadatum.

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

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

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

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

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

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

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

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

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

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

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

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

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

Option 2

\n
\n

string

\n

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

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

proxy

\n
\n

object

\n

The proxy to perform the test.

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

headers

\n
\n

object

\n

Headers to include when performing the test.

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

<any-key>

\n
\n

string

\n

A single Header.

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

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

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

query

\n
\n

object

\n

Query to use for the test.

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

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

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

service

\n
\n

string

\n

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

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

shouldTrackHops

\n
\n

boolean

\n

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

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

timeout

\n
\n

double

\n

Timeout in seconds for the test.

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

url

\n
\n

string

\n

URL to perform the test with.

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

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 [required]

\n
\n

enum

\n

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

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

device_ids

\n
\n

[string]

\n

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

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

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

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

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

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

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

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

enableSecurityTesting

\n
\n

boolean

\n

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

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

follow_redirects

\n
\n

boolean

\n

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

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

httpVersion

\n
\n

enum

\n

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

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

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

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

initialNavigationTimeout

\n
\n

int64

\n

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

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

min_failure_duration

\n
\n

int64

\n

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

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

min_location_failed

\n
\n

int64

\n

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

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

monitor_name

\n
\n

string

\n

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

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

monitor_options

\n
\n

object

\n

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

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

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

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

notification_preset_name

\n
\n

enum

\n

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

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

renotify_interval

\n
\n

int64

\n

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

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

renotify_occurrences

\n
\n

int64

\n

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

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

monitor_priority

\n
\n

int32

\n

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

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

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

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

restricted_roles

\n
\n

[string]

\n

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

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

retry

\n
\n

object

\n

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

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

count

\n
\n

int64

\n

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

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

interval

\n
\n

double

\n

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

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

rumSettings

\n
\n

object

\n

The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:

\n

{ isEnabled: false }\nRUM data is not collected.

\n

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

\n

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

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

applicationId

\n
\n

string

\n

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

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

clientTokenId

\n
\n

int64

\n

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

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

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

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

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

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

timeframes [required]

\n
\n

[object]

\n

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

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

day [required]

\n
\n

int32

\n

Number representing the day of the week.

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

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

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

tick_every

\n
\n

int64

\n

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

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

public_id

\n
\n

string

\n

The 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,mobile

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -691,7 +694,10 @@ "min_location_failed": "integer", "monitor_name": "string", "monitor_options": { - "renotify_interval": "integer" + "escalation_message": "string", + "notification_preset_name": "string", + "renotify_interval": "integer", + "renotify_occurrences": "integer" }, "monitor_priority": "integer", "noScreenshot": false, @@ -736,7 +742,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

Option 6

\n
\n

object

\n

A JavaScript assertion.

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

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

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

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

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

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

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

example

\n
\n

string

\n

Example for the variable.

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

id

\n
\n

string

\n

ID of the variable for global variables.

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

name [required]

\n
\n

string

\n

Name of the variable.

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

pattern

\n
\n

string

\n

Pattern of the variable.

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

secure

\n
\n

boolean

\n

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

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

type [required]

\n
\n

enum

\n

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

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

request

\n
\n

object

\n

Object describing the Synthetic test request.

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

allow_insecure

\n
\n

boolean

\n

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

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

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

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

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

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

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

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

type

\n
\n

enum

\n

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

default: web

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

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

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

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

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

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

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

region

\n
\n

string

\n

Region for the SIGV4 authentication.

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

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

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

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

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

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

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

type [required]

\n
\n

enum

\n

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

default: sigv4

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

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

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

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

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

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

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

type [required]

\n
\n

enum

\n

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

default: ntlm

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

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

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

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

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

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

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

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

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

type [required]

\n
\n

enum

\n

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

default: digest

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

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

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

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

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

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

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

audience

\n
\n

string

\n

Audience to use when performing the authentication.

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

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

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

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

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

resource

\n
\n

string

\n

Resource to use when performing the authentication.

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

scope

\n
\n

string

\n

Scope to use when performing the authentication.

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

tokenApiAuthentication [required]

\n
\n

enum

\n

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

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

type [required]

\n
\n

enum

\n

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

default: oauth-client

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

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

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

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

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

audience

\n
\n

string

\n

Audience to use when performing the authentication.

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

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

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

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

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

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

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

resource

\n
\n

string

\n

Resource to use when performing the authentication.

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

scope

\n
\n

string

\n

Scope to use when performing the authentication.

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

tokenApiAuthentication [required]

\n
\n

enum

\n

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

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

type [required]

\n
\n

enum

\n

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

default: oauth-rop

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

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

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

body

\n
\n

string

\n

Body to include in the test.

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

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

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

callType

\n
\n

enum

\n

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

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

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

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

cert

\n
\n

object

\n

Define a request certificate.

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

content

\n
\n

string

\n

Content of the certificate or key.

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

filename

\n
\n

string

\n

File name for the certificate or key.

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

updatedAt

\n
\n

string

\n

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

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

key

\n
\n

object

\n

Define a request certificate.

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

content

\n
\n

string

\n

Content of the certificate or key.

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

filename

\n
\n

string

\n

File name for the certificate or key.

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

updatedAt

\n
\n

string

\n

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

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

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

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

compressedJsonDescriptor

\n
\n

string

\n

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

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

compressedProtoFile

\n
\n

string

\n

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

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

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

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

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

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

files

\n
\n

[object]

\n

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

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

bucketKey

\n
\n

string

\n

Bucket key of the file.

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

content

\n
\n

string

\n

Content of the file.

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

name

\n
\n

string

\n

Name of the file.

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

originalFileName

\n
\n

string

\n

Original name of the file.

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

size

\n
\n

int64

\n

Size of the file.

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

type

\n
\n

string

\n

Type of the file.

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

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

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

headers

\n
\n

object

\n

Headers to include when performing the test.

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

<any-key>

\n
\n

string

\n

A single Header.

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

host

\n
\n

string

\n

Host name to perform the test with.

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

httpVersion

\n
\n

enum

\n

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

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

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

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

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

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

<any-key>

\n
\n

string

\n

A single metadatum.

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

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

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

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

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

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

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

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

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

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

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

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

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

Option 2

\n
\n

string

\n

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

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

proxy

\n
\n

object

\n

The proxy to perform the test.

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

headers

\n
\n

object

\n

Headers to include when performing the test.

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

<any-key>

\n
\n

string

\n

A single Header.

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

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

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

query

\n
\n

object

\n

Query to use for the test.

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

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

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

service

\n
\n

string

\n

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

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

shouldTrackHops

\n
\n

boolean

\n

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

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

timeout

\n
\n

double

\n

Timeout in seconds for the test.

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

url

\n
\n

string

\n

URL to perform the test with.

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

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,mobile

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

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

request

\n
\n

object

\n

Object describing the Synthetic test request.

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

allow_insecure

\n
\n

boolean

\n

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

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

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

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

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

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

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

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

type

\n
\n

enum

\n

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

default: web

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

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

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

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

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

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

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

region

\n
\n

string

\n

Region for the SIGV4 authentication.

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

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

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

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

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

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

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

type [required]

\n
\n

enum

\n

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

default: sigv4

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

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

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

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

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

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

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

type [required]

\n
\n

enum

\n

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

default: ntlm

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

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

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

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

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

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

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

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

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

type [required]

\n
\n

enum

\n

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

default: digest

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

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

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

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

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

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

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

audience

\n
\n

string

\n

Audience to use when performing the authentication.

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

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

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

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

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

resource

\n
\n

string

\n

Resource to use when performing the authentication.

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

scope

\n
\n

string

\n

Scope to use when performing the authentication.

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

tokenApiAuthentication [required]

\n
\n

enum

\n

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

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

type [required]

\n
\n

enum

\n

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

default: oauth-client

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

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

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

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

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

audience

\n
\n

string

\n

Audience to use when performing the authentication.

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

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

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

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

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

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

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

resource

\n
\n

string

\n

Resource to use when performing the authentication.

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

scope

\n
\n

string

\n

Scope to use when performing the authentication.

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

tokenApiAuthentication [required]

\n
\n

enum

\n

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

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

type [required]

\n
\n

enum

\n

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

default: oauth-rop

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

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

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

body

\n
\n

string

\n

Body to include in the test.

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

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

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

callType

\n
\n

enum

\n

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

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

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

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

cert

\n
\n

object

\n

Define a request certificate.

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

content

\n
\n

string

\n

Content of the certificate or key.

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

filename

\n
\n

string

\n

File name for the certificate or key.

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

updatedAt

\n
\n

string

\n

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

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

key

\n
\n

object

\n

Define a request certificate.

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

content

\n
\n

string

\n

Content of the certificate or key.

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

filename

\n
\n

string

\n

File name for the certificate or key.

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

updatedAt

\n
\n

string

\n

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

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

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

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

compressedJsonDescriptor

\n
\n

string

\n

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

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

compressedProtoFile

\n
\n

string

\n

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

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

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

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

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

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

files

\n
\n

[object]

\n

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

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

bucketKey

\n
\n

string

\n

Bucket key of the file.

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

content

\n
\n

string

\n

Content of the file.

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

name

\n
\n

string

\n

Name of the file.

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

originalFileName

\n
\n

string

\n

Original name of the file.

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

size

\n
\n

int64

\n

Size of the file.

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

type

\n
\n

string

\n

Type of the file.

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

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

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

headers

\n
\n

object

\n

Headers to include when performing the test.

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

<any-key>

\n
\n

string

\n

A single Header.

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

host

\n
\n

string

\n

Host name to perform the test with.

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

httpVersion

\n
\n

enum

\n

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

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

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

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

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

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

<any-key>

\n
\n

string

\n

A single metadatum.

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

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

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

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

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

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

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

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

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

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

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

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

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

Option 2

\n
\n

string

\n

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

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

proxy

\n
\n

object

\n

The proxy to perform the test.

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

headers

\n
\n

object

\n

Headers to include when performing the test.

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

<any-key>

\n
\n

string

\n

A single Header.

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

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

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

query

\n
\n

object

\n

Query to use for the test.

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

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

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

service

\n
\n

string

\n

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

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

shouldTrackHops

\n
\n

boolean

\n

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

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

timeout

\n
\n

double

\n

Timeout in seconds for the test.

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

url

\n
\n

string

\n

URL to perform the test with.

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

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 [required]

\n
\n

enum

\n

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

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

device_ids

\n
\n

[string]

\n

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

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

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

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

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

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

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

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

enableSecurityTesting

\n
\n

boolean

\n

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

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

follow_redirects

\n
\n

boolean

\n

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

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

httpVersion

\n
\n

enum

\n

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

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

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

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

initialNavigationTimeout

\n
\n

int64

\n

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

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

min_failure_duration

\n
\n

int64

\n

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

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

min_location_failed

\n
\n

int64

\n

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

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

monitor_name

\n
\n

string

\n

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

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

monitor_options

\n
\n

object

\n

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

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

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

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

notification_preset_name

\n
\n

enum

\n

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

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

renotify_interval

\n
\n

int64

\n

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

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

renotify_occurrences

\n
\n

int64

\n

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

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

monitor_priority

\n
\n

int32

\n

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

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

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

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

restricted_roles

\n
\n

[string]

\n

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

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

retry

\n
\n

object

\n

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

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

count

\n
\n

int64

\n

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

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

interval

\n
\n

double

\n

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

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

rumSettings

\n
\n

object

\n

The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:

\n

{ isEnabled: false }\nRUM data is not collected.

\n

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

\n

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

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

applicationId

\n
\n

string

\n

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

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

clientTokenId

\n
\n

int64

\n

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

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

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

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

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

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

timeframes [required]

\n
\n

[object]

\n

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

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

day [required]

\n
\n

int32

\n

Number representing the day of the week.

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

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

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

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

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

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

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

tick_every

\n
\n

int64

\n

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

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

public_id

\n
\n

string

\n

The 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,mobile

\n
\n \n
\n
" }, "400": { "json": { @@ -793,8 +799,21 @@ ] }, "options": { + "ci": { + "executionRule": "blocking" + }, "rumSettings": { "isEnabled": true + }, + "scheduling": { + "timeframes": [ + { + "day": 1, + "from": "07:00", + "to": "16:00" + } + ], + "timezone": "America/New_York" } } }, @@ -926,7 +945,10 @@ "min_location_failed": "integer", "monitor_name": "string", "monitor_options": { - "renotify_interval": "integer" + "escalation_message": "string", + "notification_preset_name": "string", + "renotify_interval": "integer", + "renotify_occurrences": "integer" }, "monitor_priority": "integer", "noScreenshot": false, @@ -970,7 +992,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

Option 6

\n
\n

object

\n

A JavaScript assertion.

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

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

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

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

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

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

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

example

\n
\n

string

\n

Example for the variable.

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

id

\n
\n

string

\n

ID of the variable for global variables.

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

name [required]

\n
\n

string

\n

Name of the variable.

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

pattern

\n
\n

string

\n

Pattern of the variable.

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

secure

\n
\n

boolean

\n

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

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

type [required]

\n
\n

enum

\n

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

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

request

\n
\n

object

\n

Object describing the Synthetic test request.

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

allow_insecure

\n
\n

boolean

\n

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

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

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

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

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

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

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

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

type

\n
\n

enum

\n

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

default: web

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

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

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

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

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

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

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

region

\n
\n

string

\n

Region for the SIGV4 authentication.

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

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

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

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

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

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

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

type [required]

\n
\n

enum

\n

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

default: sigv4

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

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

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

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

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

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

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

type [required]

\n
\n

enum

\n

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

default: ntlm

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

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

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

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

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

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

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

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

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

type [required]

\n
\n

enum

\n

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

default: digest

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

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

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

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

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

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

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

audience

\n
\n

string

\n

Audience to use when performing the authentication.

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

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

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

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

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

resource

\n
\n

string

\n

Resource to use when performing the authentication.

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

scope

\n
\n

string

\n

Scope to use when performing the authentication.

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

tokenApiAuthentication [required]

\n
\n

enum

\n

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

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

type [required]

\n
\n

enum

\n

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

default: oauth-client

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

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

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

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

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

audience

\n
\n

string

\n

Audience to use when performing the authentication.

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

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

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

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

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

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

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

resource

\n
\n

string

\n

Resource to use when performing the authentication.

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

scope

\n
\n

string

\n

Scope to use when performing the authentication.

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

tokenApiAuthentication [required]

\n
\n

enum

\n

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

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

type [required]

\n
\n

enum

\n

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

default: oauth-rop

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

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

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

body

\n
\n

string

\n

Body to include in the test.

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

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

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

callType

\n
\n

enum

\n

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

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

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

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

cert

\n
\n

object

\n

Define a request certificate.

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

content

\n
\n

string

\n

Content of the certificate or key.

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

filename

\n
\n

string

\n

File name for the certificate or key.

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

updatedAt

\n
\n

string

\n

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

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

key

\n
\n

object

\n

Define a request certificate.

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

content

\n
\n

string

\n

Content of the certificate or key.

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

filename

\n
\n

string

\n

File name for the certificate or key.

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

updatedAt

\n
\n

string

\n

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

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

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

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

compressedJsonDescriptor

\n
\n

string

\n

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

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

compressedProtoFile

\n
\n

string

\n

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

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

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

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

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

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

files

\n
\n

[object]

\n

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

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

bucketKey

\n
\n

string

\n

Bucket key of the file.

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

content

\n
\n

string

\n

Content of the file.

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

name

\n
\n

string

\n

Name of the file.

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

originalFileName

\n
\n

string

\n

Original name of the file.

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

size

\n
\n

int64

\n

Size of the file.

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

type

\n
\n

string

\n

Type of the file.

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

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

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

headers

\n
\n

object

\n

Headers to include when performing the test.

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

<any-key>

\n
\n

string

\n

A single Header.

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

host

\n
\n

string

\n

Host name to perform the test with.

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

httpVersion

\n
\n

enum

\n

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

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

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

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

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

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

<any-key>

\n
\n

string

\n

A single metadatum.

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

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

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

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

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

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

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

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

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

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

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

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

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

Option 2

\n
\n

string

\n

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

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

proxy

\n
\n

object

\n

The proxy to perform the test.

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

headers

\n
\n

object

\n

Headers to include when performing the test.

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

<any-key>

\n
\n

string

\n

A single Header.

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

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

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

query

\n
\n

object

\n

Query to use for the test.

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

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

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

service

\n
\n

string

\n

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

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

shouldTrackHops

\n
\n

boolean

\n

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

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

timeout

\n
\n

double

\n

Timeout in seconds for the test.

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

url

\n
\n

string

\n

URL to perform the test with.

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

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,mobile

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

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

request

\n
\n

object

\n

Object describing the Synthetic test request.

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

allow_insecure

\n
\n

boolean

\n

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

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

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

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

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

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

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

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

type

\n
\n

enum

\n

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

default: web

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

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

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

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

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

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

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

region

\n
\n

string

\n

Region for the SIGV4 authentication.

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

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

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

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

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

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

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

type [required]

\n
\n

enum

\n

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

default: sigv4

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

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

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

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

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

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

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

type [required]

\n
\n

enum

\n

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

default: ntlm

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

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

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

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

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

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

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

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

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

type [required]

\n
\n

enum

\n

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

default: digest

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

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

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

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

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

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

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

audience

\n
\n

string

\n

Audience to use when performing the authentication.

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

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

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

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

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

resource

\n
\n

string

\n

Resource to use when performing the authentication.

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

scope

\n
\n

string

\n

Scope to use when performing the authentication.

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

tokenApiAuthentication [required]

\n
\n

enum

\n

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

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

type [required]

\n
\n

enum

\n

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

default: oauth-client

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

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

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

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

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

audience

\n
\n

string

\n

Audience to use when performing the authentication.

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

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

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

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

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

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

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

resource

\n
\n

string

\n

Resource to use when performing the authentication.

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

scope

\n
\n

string

\n

Scope to use when performing the authentication.

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

tokenApiAuthentication [required]

\n
\n

enum

\n

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

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

type [required]

\n
\n

enum

\n

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

default: oauth-rop

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

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

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

body

\n
\n

string

\n

Body to include in the test.

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

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

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

callType

\n
\n

enum

\n

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

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

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

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

cert

\n
\n

object

\n

Define a request certificate.

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

content

\n
\n

string

\n

Content of the certificate or key.

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

filename

\n
\n

string

\n

File name for the certificate or key.

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

updatedAt

\n
\n

string

\n

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

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

key

\n
\n

object

\n

Define a request certificate.

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

content

\n
\n

string

\n

Content of the certificate or key.

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

filename

\n
\n

string

\n

File name for the certificate or key.

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

updatedAt

\n
\n

string

\n

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

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

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

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

compressedJsonDescriptor

\n
\n

string

\n

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

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

compressedProtoFile

\n
\n

string

\n

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

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

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

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

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

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

files

\n
\n

[object]

\n

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

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

bucketKey

\n
\n

string

\n

Bucket key of the file.

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

content

\n
\n

string

\n

Content of the file.

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

name

\n
\n

string

\n

Name of the file.

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

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

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 [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:

\n

{ isEnabled: false }\nRUM data is not collected.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The 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,mobile

\n
\n \n
\n
" } }, "CreateSyntheticsAPITest": { @@ -1091,7 +1113,10 @@ "min_location_failed": "integer", "monitor_name": "string", "monitor_options": { - "renotify_interval": "integer" + "escalation_message": "string", + "notification_preset_name": "string", + "renotify_interval": "integer", + "renotify_occurrences": "integer" }, "monitor_priority": "integer", "noScreenshot": false, @@ -1127,7 +1152,7 @@ ], "type": "api" }, - "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic API test.

\n
\n
\n
\n
\n
\n

assertions

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test. Required for single API tests.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

\n
\n
\n
\n
\n
\n

example

\n
\n

string

\n

Example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[ <oneOf>]

\n

When the test subtype is multi, the steps of the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Test step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

allowFailure

\n
\n

boolean

\n

Determines whether or not to continue with test if this step fails.

\n
\n \n
\n
\n
\n
\n
\n

assertions [required]

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extractedValues

\n
\n

[object]

\n

Array of values to parse and save as variables from the response.

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

When type is http_header or grpc_metadata, name of the header or metadatum to extract.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the variable to extract.

\n
\n \n
\n
\n
\n
\n
\n

parser

\n
\n

object

\n

Details of the parser to use for the global variable.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Regex or JSON path used for the parser. Not used with type raw.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Determines whether or not the extracted value will be obfuscated.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isCritical

\n
\n

boolean

\n

Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The Wait step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

int32

\n

The time to wait in seconds. Minimum value: 0. Maximum value: 180.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

variablesFromScript

\n
\n

string

\n

Variables defined from JavaScript code.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

locations [required]

\n
\n

[string]

\n

Array of locations used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Notification message associated with the test.

\n
\n \n
\n
\n
\n
\n
\n

monitor_id

\n
\n

int64

\n

The associated monitor ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the test.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Object describing the extra options for a Synthetic test.

\n
\n
\n
\n
\n
\n

accept_self_signed

\n
\n

boolean

\n

For SSL test, whether or not the test should allow self signed\ncertificates.

\n
\n \n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in an API test.

\n
\n \n
\n
\n
\n
\n
\n

checkCertificateRevocation

\n
\n

boolean

\n

For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

\n
\n \n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule

\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,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[ <oneOf>]

\n

When the test subtype is multi, the steps of the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Test step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

allowFailure

\n
\n

boolean

\n

Determines whether or not to continue with test if this step fails.

\n
\n \n
\n
\n
\n
\n
\n

assertions [required]

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extractedValues

\n
\n

[object]

\n

Array of values to parse and save as variables from the response.

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

When type is http_header or grpc_metadata, name of the header or metadatum to extract.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the variable to extract.

\n
\n \n
\n
\n
\n
\n
\n

parser

\n
\n

object

\n

Details of the parser to use for the global variable.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Regex or JSON path used for the parser. Not used with type raw.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Determines whether or not the extracted value will be obfuscated.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isCritical

\n
\n

boolean

\n

Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The Wait step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

int32

\n

The time to wait in seconds. Minimum value: 0. Maximum value: 180.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

variablesFromScript

\n
\n

string

\n

Variables defined from JavaScript code.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

locations [required]

\n
\n

[string]

\n

Array of locations used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Notification message associated with the test.

\n
\n \n
\n
\n
\n
\n
\n

monitor_id

\n
\n

int64

\n

The associated monitor ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the test.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Object describing the extra options for a Synthetic test.

\n
\n
\n
\n
\n
\n

accept_self_signed

\n
\n

boolean

\n

For SSL test, whether or not the test should allow self signed\ncertificates.

\n
\n \n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in an API test.

\n
\n \n
\n
\n
\n
\n
\n

checkCertificateRevocation

\n
\n

boolean

\n

For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

\n
\n \n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:

\n

{ isEnabled: false }\nRUM data is not collected.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The public ID for the test.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused

\n
\n \n
\n
\n
\n
\n
\n

subtype

\n
\n

enum

\n

The subtype of the Synthetic API test, http, ssl, tcp,\ndns, icmp, udp, websocket, grpc or multi. \nAllowed enum values: http,ssl,tcp,dns,multi,icmp,udp,websocket,grpc

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Array of tags attached to the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Synthetic test, api. \nAllowed enum values: api

default: api

\n
\n \n
\n
" }, "400": { "json": { @@ -1183,8 +1208,21 @@ "message": "Notification message", "name": "Example test name", "options": { + "ci": { + "executionRule": "blocking" + }, "rumSettings": { "isEnabled": true + }, + "scheduling": { + "timeframes": [ + { + "day": 1, + "from": "07:00", + "to": "16:00" + } + ], + "timezone": "America/New_York" } }, "type": "api" @@ -1303,7 +1341,10 @@ "min_location_failed": "integer", "monitor_name": "string", "monitor_options": { - "renotify_interval": "integer" + "escalation_message": "string", + "notification_preset_name": "string", + "renotify_interval": "integer", + "renotify_occurrences": "integer" }, "monitor_priority": "integer", "noScreenshot": false, @@ -1338,7 +1379,7 @@ ], "type": "api" }, - "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic API test.

\n
\n
\n
\n
\n
\n

assertions

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test. Required for single API tests.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

\n
\n
\n
\n
\n
\n

example

\n
\n

string

\n

Example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[ <oneOf>]

\n

When the test subtype is multi, the steps of the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Test step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

allowFailure

\n
\n

boolean

\n

Determines whether or not to continue with test if this step fails.

\n
\n \n
\n
\n
\n
\n
\n

assertions [required]

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extractedValues

\n
\n

[object]

\n

Array of values to parse and save as variables from the response.

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

When type is http_header or grpc_metadata, name of the header or metadatum to extract.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the variable to extract.

\n
\n \n
\n
\n
\n
\n
\n

parser

\n
\n

object

\n

Details of the parser to use for the global variable.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Regex or JSON path used for the parser. Not used with type raw.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Determines whether or not the extracted value will be obfuscated.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isCritical

\n
\n

boolean

\n

Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The Wait step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

int32

\n

The time to wait in seconds. Minimum value: 0. Maximum value: 180.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

variablesFromScript

\n
\n

string

\n

Variables defined from JavaScript code.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

locations [required]

\n
\n

[string]

\n

Array of locations used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Notification message associated with the test.

\n
\n \n
\n
\n
\n
\n
\n

monitor_id

\n
\n

int64

\n

The associated monitor ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the test.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Object describing the extra options for a Synthetic test.

\n
\n
\n
\n
\n
\n

accept_self_signed

\n
\n

boolean

\n

For SSL test, whether or not the test should allow self signed\ncertificates.

\n
\n \n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in an API test.

\n
\n \n
\n
\n
\n
\n
\n

checkCertificateRevocation

\n
\n

boolean

\n

For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

\n
\n \n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule

\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,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[ <oneOf>]

\n

When the test subtype is multi, the steps of the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Test step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

allowFailure

\n
\n

boolean

\n

Determines whether or not to continue with test if this step fails.

\n
\n \n
\n
\n
\n
\n
\n

assertions [required]

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extractedValues

\n
\n

[object]

\n

Array of values to parse and save as variables from the response.

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

When type is http_header or grpc_metadata, name of the header or metadatum to extract.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the variable to extract.

\n
\n \n
\n
\n
\n
\n
\n

parser

\n
\n

object

\n

Details of the parser to use for the global variable.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Regex or JSON path used for the parser. Not used with type raw.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Determines whether or not the extracted value will be obfuscated.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isCritical

\n
\n

boolean

\n

Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The Wait step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

int32

\n

The time to wait in seconds. Minimum value: 0. Maximum value: 180.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

variablesFromScript

\n
\n

string

\n

Variables defined from JavaScript code.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

locations [required]

\n
\n

[string]

\n

Array of locations used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Notification message associated with the test.

\n
\n \n
\n
\n
\n
\n
\n

monitor_id

\n
\n

int64

\n

The associated monitor ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the test.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Object describing the extra options for a Synthetic test.

\n
\n
\n
\n
\n
\n

accept_self_signed

\n
\n

boolean

\n

For SSL test, whether or not the test should allow self signed\ncertificates.

\n
\n \n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in an API test.

\n
\n \n
\n
\n
\n
\n
\n

checkCertificateRevocation

\n
\n

boolean

\n

For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

\n
\n \n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:

\n

{ isEnabled: false }\nRUM data is not collected.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The public ID for the test.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused

\n
\n \n
\n
\n
\n
\n
\n

subtype

\n
\n

enum

\n

The subtype of the Synthetic API test, http, ssl, tcp,\ndns, icmp, udp, websocket, grpc or multi. \nAllowed enum values: http,ssl,tcp,dns,multi,icmp,udp,websocket,grpc

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Array of tags attached to the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Synthetic test, api. \nAllowed enum values: api

default: api

\n
\n \n
\n
" } }, "GetAPITest": { @@ -1459,7 +1500,10 @@ "min_location_failed": "integer", "monitor_name": "string", "monitor_options": { - "renotify_interval": "integer" + "escalation_message": "string", + "notification_preset_name": "string", + "renotify_interval": "integer", + "renotify_occurrences": "integer" }, "monitor_priority": "integer", "noScreenshot": false, @@ -1495,7 +1539,7 @@ ], "type": "api" }, - "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic API test.

\n
\n
\n
\n
\n
\n

assertions

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test. Required for single API tests.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

\n
\n
\n
\n
\n
\n

example

\n
\n

string

\n

Example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[ <oneOf>]

\n

When the test subtype is multi, the steps of the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Test step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

allowFailure

\n
\n

boolean

\n

Determines whether or not to continue with test if this step fails.

\n
\n \n
\n
\n
\n
\n
\n

assertions [required]

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extractedValues

\n
\n

[object]

\n

Array of values to parse and save as variables from the response.

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

When type is http_header or grpc_metadata, name of the header or metadatum to extract.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the variable to extract.

\n
\n \n
\n
\n
\n
\n
\n

parser

\n
\n

object

\n

Details of the parser to use for the global variable.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Regex or JSON path used for the parser. Not used with type raw.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Determines whether or not the extracted value will be obfuscated.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isCritical

\n
\n

boolean

\n

Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The Wait step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

int32

\n

The time to wait in seconds. Minimum value: 0. Maximum value: 180.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

variablesFromScript

\n
\n

string

\n

Variables defined from JavaScript code.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

locations [required]

\n
\n

[string]

\n

Array of locations used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Notification message associated with the test.

\n
\n \n
\n
\n
\n
\n
\n

monitor_id

\n
\n

int64

\n

The associated monitor ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the test.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Object describing the extra options for a Synthetic test.

\n
\n
\n
\n
\n
\n

accept_self_signed

\n
\n

boolean

\n

For SSL test, whether or not the test should allow self signed\ncertificates.

\n
\n \n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in an API test.

\n
\n \n
\n
\n
\n
\n
\n

checkCertificateRevocation

\n
\n

boolean

\n

For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

\n
\n \n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule

\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,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[ <oneOf>]

\n

When the test subtype is multi, the steps of the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Test step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

allowFailure

\n
\n

boolean

\n

Determines whether or not to continue with test if this step fails.

\n
\n \n
\n
\n
\n
\n
\n

assertions [required]

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extractedValues

\n
\n

[object]

\n

Array of values to parse and save as variables from the response.

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

When type is http_header or grpc_metadata, name of the header or metadatum to extract.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the variable to extract.

\n
\n \n
\n
\n
\n
\n
\n

parser

\n
\n

object

\n

Details of the parser to use for the global variable.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Regex or JSON path used for the parser. Not used with type raw.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Determines whether or not the extracted value will be obfuscated.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isCritical

\n
\n

boolean

\n

Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The Wait step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

int32

\n

The time to wait in seconds. Minimum value: 0. Maximum value: 180.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

variablesFromScript

\n
\n

string

\n

Variables defined from JavaScript code.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

locations [required]

\n
\n

[string]

\n

Array of locations used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Notification message associated with the test.

\n
\n \n
\n
\n
\n
\n
\n

monitor_id

\n
\n

int64

\n

The associated monitor ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the test.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Object describing the extra options for a Synthetic test.

\n
\n
\n
\n
\n
\n

accept_self_signed

\n
\n

boolean

\n

For SSL test, whether or not the test should allow self signed\ncertificates.

\n
\n \n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in an API test.

\n
\n \n
\n
\n
\n
\n
\n

checkCertificateRevocation

\n
\n

boolean

\n

For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

\n
\n \n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:

\n

{ isEnabled: false }\nRUM data is not collected.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The public ID for the test.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused

\n
\n \n
\n
\n
\n
\n
\n

subtype

\n
\n

enum

\n

The subtype of the Synthetic API test, http, ssl, tcp,\ndns, icmp, udp, websocket, grpc or multi. \nAllowed enum values: http,ssl,tcp,dns,multi,icmp,udp,websocket,grpc

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Array of tags attached to the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Synthetic test, api. \nAllowed enum values: api

default: api

\n
\n \n
\n
" }, "403": { "json": { @@ -1646,7 +1690,10 @@ "min_location_failed": "integer", "monitor_name": "string", "monitor_options": { - "renotify_interval": "integer" + "escalation_message": "string", + "notification_preset_name": "string", + "renotify_interval": "integer", + "renotify_occurrences": "integer" }, "monitor_priority": "integer", "noScreenshot": false, @@ -1682,7 +1729,7 @@ ], "type": "api" }, - "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic API test.

\n
\n
\n
\n
\n
\n

assertions

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test. Required for single API tests.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

\n
\n
\n
\n
\n
\n

example

\n
\n

string

\n

Example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[ <oneOf>]

\n

When the test subtype is multi, the steps of the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Test step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

allowFailure

\n
\n

boolean

\n

Determines whether or not to continue with test if this step fails.

\n
\n \n
\n
\n
\n
\n
\n

assertions [required]

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extractedValues

\n
\n

[object]

\n

Array of values to parse and save as variables from the response.

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

When type is http_header or grpc_metadata, name of the header or metadatum to extract.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the variable to extract.

\n
\n \n
\n
\n
\n
\n
\n

parser

\n
\n

object

\n

Details of the parser to use for the global variable.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Regex or JSON path used for the parser. Not used with type raw.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Determines whether or not the extracted value will be obfuscated.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isCritical

\n
\n

boolean

\n

Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The Wait step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

int32

\n

The time to wait in seconds. Minimum value: 0. Maximum value: 180.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

variablesFromScript

\n
\n

string

\n

Variables defined from JavaScript code.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

locations [required]

\n
\n

[string]

\n

Array of locations used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Notification message associated with the test.

\n
\n \n
\n
\n
\n
\n
\n

monitor_id

\n
\n

int64

\n

The associated monitor ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the test.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Object describing the extra options for a Synthetic test.

\n
\n
\n
\n
\n
\n

accept_self_signed

\n
\n

boolean

\n

For SSL test, whether or not the test should allow self signed\ncertificates.

\n
\n \n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in an API test.

\n
\n \n
\n
\n
\n
\n
\n

checkCertificateRevocation

\n
\n

boolean

\n

For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

\n
\n \n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule

\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,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[ <oneOf>]

\n

When the test subtype is multi, the steps of the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Test step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

allowFailure

\n
\n

boolean

\n

Determines whether or not to continue with test if this step fails.

\n
\n \n
\n
\n
\n
\n
\n

assertions [required]

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extractedValues

\n
\n

[object]

\n

Array of values to parse and save as variables from the response.

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

When type is http_header or grpc_metadata, name of the header or metadatum to extract.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the variable to extract.

\n
\n \n
\n
\n
\n
\n
\n

parser

\n
\n

object

\n

Details of the parser to use for the global variable.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Regex or JSON path used for the parser. Not used with type raw.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Determines whether or not the extracted value will be obfuscated.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isCritical

\n
\n

boolean

\n

Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The Wait step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

int32

\n

The time to wait in seconds. Minimum value: 0. Maximum value: 180.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

variablesFromScript

\n
\n

string

\n

Variables defined from JavaScript code.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

locations [required]

\n
\n

[string]

\n

Array of locations used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Notification message associated with the test.

\n
\n \n
\n
\n
\n
\n
\n

monitor_id

\n
\n

int64

\n

The associated monitor ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the test.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Object describing the extra options for a Synthetic test.

\n
\n
\n
\n
\n
\n

accept_self_signed

\n
\n

boolean

\n

For SSL test, whether or not the test should allow self signed\ncertificates.

\n
\n \n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in an API test.

\n
\n \n
\n
\n
\n
\n
\n

checkCertificateRevocation

\n
\n

boolean

\n

For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

\n
\n \n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:

\n

{ isEnabled: false }\nRUM data is not collected.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The public ID for the test.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused

\n
\n \n
\n
\n
\n
\n
\n

subtype

\n
\n

enum

\n

The subtype of the Synthetic API test, http, ssl, tcp,\ndns, icmp, udp, websocket, grpc or multi. \nAllowed enum values: http,ssl,tcp,dns,multi,icmp,udp,websocket,grpc

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Array of tags attached to the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Synthetic test, api. \nAllowed enum values: api

default: api

\n
\n \n
\n
" }, "400": { "json": { @@ -1738,8 +1785,21 @@ "message": "Notification message", "name": "Example test name", "options": { + "ci": { + "executionRule": "blocking" + }, "rumSettings": { "isEnabled": true + }, + "scheduling": { + "timeframes": [ + { + "day": 1, + "from": "07:00", + "to": "16:00" + } + ], + "timezone": "America/New_York" } }, "type": "api" @@ -1858,7 +1918,10 @@ "min_location_failed": "integer", "monitor_name": "string", "monitor_options": { - "renotify_interval": "integer" + "escalation_message": "string", + "notification_preset_name": "string", + "renotify_interval": "integer", + "renotify_occurrences": "integer" }, "monitor_priority": "integer", "noScreenshot": false, @@ -1893,7 +1956,7 @@ ], "type": "api" }, - "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic API test.

\n
\n
\n
\n
\n
\n

assertions

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test. Required for single API tests.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

\n
\n
\n
\n
\n
\n

example

\n
\n

string

\n

Example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[ <oneOf>]

\n

When the test subtype is multi, the steps of the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Test step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

allowFailure

\n
\n

boolean

\n

Determines whether or not to continue with test if this step fails.

\n
\n \n
\n
\n
\n
\n
\n

assertions [required]

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extractedValues

\n
\n

[object]

\n

Array of values to parse and save as variables from the response.

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

When type is http_header or grpc_metadata, name of the header or metadatum to extract.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the variable to extract.

\n
\n \n
\n
\n
\n
\n
\n

parser

\n
\n

object

\n

Details of the parser to use for the global variable.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Regex or JSON path used for the parser. Not used with type raw.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Determines whether or not the extracted value will be obfuscated.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isCritical

\n
\n

boolean

\n

Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The Wait step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

int32

\n

The time to wait in seconds. Minimum value: 0. Maximum value: 180.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

variablesFromScript

\n
\n

string

\n

Variables defined from JavaScript code.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

locations [required]

\n
\n

[string]

\n

Array of locations used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Notification message associated with the test.

\n
\n \n
\n
\n
\n
\n
\n

monitor_id

\n
\n

int64

\n

The associated monitor ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the test.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Object describing the extra options for a Synthetic test.

\n
\n
\n
\n
\n
\n

accept_self_signed

\n
\n

boolean

\n

For SSL test, whether or not the test should allow self signed\ncertificates.

\n
\n \n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in an API test.

\n
\n \n
\n
\n
\n
\n
\n

checkCertificateRevocation

\n
\n

boolean

\n

For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

\n
\n \n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule

\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,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[ <oneOf>]

\n

When the test subtype is multi, the steps of the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The Test step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

allowFailure

\n
\n

boolean

\n

Determines whether or not to continue with test if this step fails.

\n
\n \n
\n
\n
\n
\n
\n

assertions [required]

\n
\n

[ <oneOf>]

\n

Array of assertions used for the test.

default:

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

An assertion which uses a simple target.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: contains,doesNotContain,is,isNot,lessThan,lessThanOrEqual,moreThan,moreThanOrEqual,matches,doesNotMatch,validates,isInMoreThan,isInLessThan,doesNotExist,isUndefined

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

timingsScope

\n
\n

enum

\n

Timings scope for response time assertions. \nAllowed enum values: all,withoutDNS

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

An assertion which targets body hash.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: md5,sha1,sha256

\n
\n \n
\n
\n
\n
\n
\n

target [required]

\n
\n

\n

Value used by the operator.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: bodyHash

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

An assertion for the validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONPath operator.

\n
\n
\n
\n
\n
\n

elementsOperator

\n
\n

string

\n

The element from the list of results to assert on. To choose from the first element in the list firstElementMatches, every element in the list everyElementMatches, at least one element in the list atLeastOneElementMatches or the serialized value of the list serializationMatches.

\n
\n \n
\n
\n
\n
\n
\n

jsonPath

\n
\n

string

\n

The JSON path to assert.

\n
\n \n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

An assertion for the validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesJSONSchema

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesJSONSchema operator.

\n
\n
\n
\n
\n
\n

jsonSchema

\n
\n

string

\n

The JSON Schema to assert.

\n
\n \n
\n
\n
\n
\n
\n

metaSchema

\n
\n

enum

\n

The JSON Schema meta-schema version used in the assertion. \nAllowed enum values: draft-07,draft-06

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

An assertion for the validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

Assertion operator to apply. \nAllowed enum values: validatesXPath

\n
\n \n
\n
\n
\n
\n
\n

property

\n
\n

string

\n

The associated assertion property.

\n
\n \n
\n
\n
\n
\n
\n

target

\n
\n

object

\n

Composed target for validatesXPath operator.

\n
\n
\n
\n
\n
\n

operator

\n
\n

string

\n

The specific operator to use on the path.

\n
\n \n
\n
\n
\n
\n
\n

targetValue

\n
\n

\n

The path target value to compare to.

\n
\n \n
\n
\n
\n
\n
\n

xPath

\n
\n

string

\n

The X path to assert.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: body,header,statusCode,certificate,responseTime,property,recordEvery,recordSome,tlsVersion,minTlsVersion,latency,packetLossPercentage,packetsReceived,networkHop,receivedMessage,grpcHealthcheckStatus,grpcMetadata,grpcProto,connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

extractedValues

\n
\n

[object]

\n

Array of values to parse and save as variables from the response.

\n
\n
\n
\n
\n
\n

field

\n
\n

string

\n

When type is http_header or grpc_metadata, name of the header or metadatum to extract.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the variable to extract.

\n
\n \n
\n
\n
\n
\n
\n

parser

\n
\n

object

\n

Details of the parser to use for the global variable.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of parser for a Synthetic global variable from a synthetics test. \nAllowed enum values: raw,json_path,regex,x_path

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Regex or JSON path used for the parser. Not used with type raw.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Determines whether or not the extracted value will be obfuscated.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Property of the Synthetic Test Response to extract into a local variable. \nAllowed enum values: grpc_message,grpc_metadata,http_body,http_header,http_status_code

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

isCritical

\n
\n

boolean

\n

Determines whether or not to consider the entire test as failed if this step fails.\nCan be used only if allowFailure is true.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API test step. \nAllowed enum values: http,grpc

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The Wait step used in a Synthetic multi-step API test.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the step.

\n
\n \n
\n
\n
\n
\n
\n

subtype [required]

\n
\n

enum

\n

The subtype of the Synthetic multi-step API wait step. \nAllowed enum values: wait

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

int32

\n

The time to wait in seconds. Minimum value: 0. Maximum value: 180.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

variablesFromScript

\n
\n

string

\n

Variables defined from JavaScript code.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

locations [required]

\n
\n

[string]

\n

Array of locations used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

message [required]

\n
\n

string

\n

Notification message associated with the test.

\n
\n \n
\n
\n
\n
\n
\n

monitor_id

\n
\n

int64

\n

The associated monitor ID.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the test.

\n
\n \n
\n
\n
\n
\n
\n

options [required]

\n
\n

object

\n

Object describing the extra options for a Synthetic test.

\n
\n
\n
\n
\n
\n

accept_self_signed

\n
\n

boolean

\n

For SSL test, whether or not the test should allow self signed\ncertificates.

\n
\n \n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in an API test.

\n
\n \n
\n
\n
\n
\n
\n

checkCertificateRevocation

\n
\n

boolean

\n

For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

\n
\n \n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:

\n

{ isEnabled: false }\nRUM data is not collected.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The public ID for the test.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Define whether you want to start (live) or pause (paused) a\nSynthetic test. \nAllowed enum values: live,paused

\n
\n \n
\n
\n
\n
\n
\n

subtype

\n
\n

enum

\n

The subtype of the Synthetic API test, http, ssl, tcp,\ndns, icmp, udp, websocket, grpc or multi. \nAllowed enum values: http,ssl,tcp,dns,multi,icmp,udp,websocket,grpc

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Array of tags attached to the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Synthetic test, api. \nAllowed enum values: api

default: api

\n
\n \n
\n
" } }, "CreateSyntheticsBrowserTest": { @@ -2029,7 +2092,10 @@ "min_location_failed": "integer", "monitor_name": "string", "monitor_options": { - "renotify_interval": "integer" + "escalation_message": "string", + "notification_preset_name": "string", + "renotify_interval": "integer", + "renotify_occurrences": "integer" }, "monitor_priority": "integer", "noScreenshot": false, @@ -2075,7 +2141,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

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

\n
\n
\n
\n
\n
\n

example

\n
\n

string

\n

Example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

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,email

\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

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

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 [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:

\n

{ isEnabled: false }\nRUM data is not collected.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The public ID 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": { @@ -2140,8 +2206,21 @@ "message": "", "name": "Example test name", "options": { + "ci": { + "executionRule": "blocking" + }, "rumSettings": { "isEnabled": true + }, + "scheduling": { + "timeframes": [ + { + "day": 1, + "from": "07:00", + "to": "16:00" + } + ], + "timezone": "America/New_York" } }, "type": "browser" @@ -2275,7 +2354,10 @@ "min_location_failed": "integer", "monitor_name": "string", "monitor_options": { - "renotify_interval": "integer" + "escalation_message": "string", + "notification_preset_name": "string", + "renotify_interval": "integer", + "renotify_occurrences": "integer" }, "monitor_priority": "integer", "noScreenshot": false, @@ -2320,7 +2402,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

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

\n
\n
\n
\n
\n
\n

example

\n
\n

string

\n

Example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

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,email

\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

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

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 [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:

\n

{ isEnabled: false }\nRUM data is not collected.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The public ID 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": { @@ -2456,7 +2538,10 @@ "min_location_failed": "integer", "monitor_name": "string", "monitor_options": { - "renotify_interval": "integer" + "escalation_message": "string", + "notification_preset_name": "string", + "renotify_interval": "integer", + "renotify_occurrences": "integer" }, "monitor_priority": "integer", "noScreenshot": false, @@ -2502,7 +2587,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

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

\n
\n
\n
\n
\n
\n

example

\n
\n

string

\n

Example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

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,email

\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

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

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 [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:

\n

{ isEnabled: false }\nRUM data is not collected.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The public ID 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": { @@ -2668,7 +2753,10 @@ "min_location_failed": "integer", "monitor_name": "string", "monitor_options": { - "renotify_interval": "integer" + "escalation_message": "string", + "notification_preset_name": "string", + "renotify_interval": "integer", + "renotify_occurrences": "integer" }, "monitor_priority": "integer", "noScreenshot": false, @@ -2714,7 +2802,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

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

\n
\n
\n
\n
\n
\n

example

\n
\n

string

\n

Example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

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,email

\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

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

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 [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:

\n

{ isEnabled: false }\nRUM data is not collected.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The public ID 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": { @@ -2779,8 +2867,21 @@ "message": "", "name": "Example test name", "options": { + "ci": { + "executionRule": "blocking" + }, "rumSettings": { "isEnabled": true + }, + "scheduling": { + "timeframes": [ + { + "day": 1, + "from": "07:00", + "to": "16:00" + } + ], + "timezone": "America/New_York" } }, "type": "browser" @@ -2914,7 +3015,10 @@ "min_location_failed": "integer", "monitor_name": "string", "monitor_options": { - "renotify_interval": "integer" + "escalation_message": "string", + "notification_preset_name": "string", + "renotify_interval": "integer", + "renotify_occurrences": "integer" }, "monitor_priority": "integer", "noScreenshot": false, @@ -2959,7 +3063,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

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

\n
\n
\n
\n
\n
\n

example

\n
\n

string

\n

Example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request [required]

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

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,email

\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

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

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 [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:

\n

{ isEnabled: false }\nRUM data is not collected.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The public ID 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": { @@ -3296,9 +3400,7 @@ "json": { "config": { "initialApplicationArguments": { - "propertyNames": { - "pattern": "^(?!_dd).*$" - } + "": "string" }, "variables": [ { @@ -3321,10 +3423,8 @@ "allowApplicationCrash": false, "bindings": [ { - "items": { - "principals": [], - "role": "string" - } + "principals": [], + "relation": "string" } ], "ci": { @@ -3337,9 +3437,9 @@ "disableAutoAcceptAlert": false, "min_failure_duration": "integer", "mobileApplication": { - "applicationId": "string", - "referenceId": "string", - "referenceType": "string" + "applicationId": "00000000-0000-0000-0000-aaaaaaaaaaaa", + "referenceId": "00000000-0000-0000-0000-aaaaaaaaaaab", + "referenceType": "latest" }, "monitor_name": "string", "monitor_options": { @@ -3367,7 +3467,7 @@ ], "timezone": "America/New_York" }, - "tick_every": "integer", + "tick_every": 300, "verbosity": "integer" }, "public_id": "123-abc-456", @@ -3377,9 +3477,51 @@ "allowFailure": false, "hasNewStepElement": false, "isCritical": false, - "name": "string", + "name": "", "noScreenshot": false, - "params": {}, + "params": { + "check": "string", + "delay": "integer", + "direction": "string", + "element": { + "context": "string", + "contextType": "string", + "elementDescription": "string", + "multiLocator": {}, + "relativePosition": { + "x": "integer", + "y": "integer" + }, + "textContent": "string", + "userLocator": { + "failTestOnCannotLocate": false, + "values": [ + { + "type": "string", + "value": "string" + } + ] + }, + "viewName": "string" + }, + "enable": false, + "maxScrolls": "integer", + "positions": [ + { + "x": "integer", + "y": "integer" + } + ], + "subtestPublicId": "string", + "value": "string", + "variable": { + "example": "", + "name": "VAR_NAME" + }, + "withEnter": false, + "x": "integer", + "y": "integer" + }, "publicId": "pub-lic-id0", "timeout": "integer", "type": "assertElementContent" @@ -3390,7 +3532,7 @@ ], "type": "mobile" }, - "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic mobile test.

\n
\n
\n
\n
\n
\n

initialApplicationArguments

\n
\n

object

\n

Initial application arguments for a mobile test.

\n
\n
\n
\n
\n
\n

propertyNames

\n
\n

object

\n

Name of the property.

\n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

The propertyNames pattern.

\n
\n \n
\n
\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 of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

The SyntheticsMobileTest device_ids.

\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 [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

allowApplicationCrash

\n
\n

boolean

\n

The SyntheticsMobileTestOptions allowApplicationCrash.

\n
\n \n
\n
\n
\n
\n
\n

bindings

\n
\n

[object]

\n

Array of bindings used for the mobile test.

\n
\n
\n
\n
\n
\n

items

\n
\n

object

\n

Object describing the binding used for a mobile test.

\n
\n
\n
\n
\n
\n

principals

\n
\n

[string]

\n

List of principals for a mobile test binding.

\n
\n \n
\n
\n
\n
\n
\n

role

\n
\n

enum

\n

The definition of SyntheticsMobileTestBindingItemsRole object. \nAllowed enum values: editor,viewer

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

defaultStepTimeout

\n
\n

int32

\n

The SyntheticsMobileTestOptions defaultStepTimeout.

\n
\n \n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For mobile test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableAutoAcceptAlert

\n
\n

boolean

\n

The SyntheticsMobileTestOptions disableAutoAcceptAlert.

\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

mobileApplication

\n
\n

object

\n

Mobile application for mobile synthetics test.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

Application ID of the mobile application.

\n
\n \n
\n
\n
\n
\n
\n

referenceId

\n
\n

string

\n

Reference ID of the mobile application.

\n
\n \n
\n
\n
\n
\n
\n

referenceType

\n
\n

enum

\n

Reference type for the mobile application for a mobile synthetics test. \nAllowed enum values: latest,version

\n
\n \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 mobile Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The definition of SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName object. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The SyntheticsMobileTestOptionsMonitorOptions renotify_occurrences.

\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

The SyntheticsMobileTestOptions noScreenshot.

\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

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

verbosity

\n
\n

int32

\n

The SyntheticsMobileTestOptions verbosity.

\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

hasNewStepElement

\n
\n

boolean

\n

A boolean set to determine if the step has a new step element.

\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 mobile step.

\n
\n \n
\n
\n
\n
\n
\n

publicId

\n
\n

string

\n

The public ID 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 mobile Synthetic test. \nAllowed enum values: assertElementContent,assertScreenContains,assertScreenLacks,doubleTap,extractVariable,flick,openDeeplink,playSubTest,pressBack,restartApplication,rotate,scroll,scrollToElement,tap,toggleWiFi,typeText,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, mobile. \nAllowed enum values: mobile

default: mobile

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic mobile test.

\n
\n
\n
\n
\n
\n

initialApplicationArguments

\n
\n

object

\n

Initial application arguments for a mobile test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single application argument.

\n
\n \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 of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

Array with the different device IDs 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 [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

allowApplicationCrash

\n
\n

boolean

\n

A boolean to set if an application crash would mark the test as failed.

\n
\n \n
\n
\n
\n
\n
\n

bindings

\n
\n

[object]

\n

Array of bindings used for the mobile test.

\n
\n
\n
\n
\n
\n

principals

\n
\n

[string]

\n

List of principals for a mobile test binding.

\n
\n \n
\n
\n
\n
\n
\n

relation

\n
\n

enum

\n

The type of relation for the binding. \nAllowed enum values: editor,viewer

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

defaultStepTimeout

\n
\n

int32

\n

The default timeout for steps in the test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n

device_ids [required]

\n
\n

[string]

\n

For mobile test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableAutoAcceptAlert

\n
\n

boolean

\n

A boolean to disable auto accepting alerts.

\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

mobileApplication [required]

\n
\n

object

\n

Mobile application for mobile synthetics test.

\n
\n
\n
\n
\n
\n

applicationId [required]

\n
\n

string

\n

Application ID of the mobile application.

\n
\n \n
\n
\n
\n
\n
\n

referenceId [required]

\n
\n

string

\n

Reference ID of the mobile application.

\n
\n \n
\n
\n
\n
\n
\n

referenceType [required]

\n
\n

enum

\n

Reference type for the mobile application for a mobile synthetics test. \nAllowed enum values: latest,version

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

\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

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every [required]

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n

verbosity

\n
\n

int32

\n

The level of verbosity for the mobile test.

\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

hasNewStepElement

\n
\n

boolean

\n

A boolean set to determine if the step has a new step element.

\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 [required]

\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 [required]

\n
\n

object

\n

The parameters of a mobile step.

\n
\n
\n
\n
\n
\n

check

\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

delay

\n
\n

int64

\n

Number of milliseconds to wait between inputs in a typeText step type.

\n
\n \n
\n
\n
\n
\n
\n

direction

\n
\n

enum

\n

The direction of the scroll for a scrollToElement step type. \nAllowed enum values: up,down,left,right

\n
\n \n
\n
\n
\n
\n
\n

element

\n
\n

object

\n

Information about the element used for a step.

\n
\n
\n
\n
\n
\n

context

\n
\n

string

\n

Context of the element.

\n
\n \n
\n
\n
\n
\n
\n

contextType

\n
\n

enum

\n

Type of the context that the element is in. \nAllowed enum values: native,web

\n
\n \n
\n
\n
\n
\n
\n

elementDescription

\n
\n

string

\n

Description of the element.

\n
\n \n
\n
\n
\n
\n
\n

multiLocator

\n
\n

object

\n

Multi-locator to find the element.

\n
\n \n
\n
\n
\n
\n
\n

relativePosition

\n
\n

object

\n

Position of the action relative to the element.

\n
\n
\n
\n
\n
\n

x

\n
\n

int64

\n

The relativePosition on the x axis for the element.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

int64

\n

The relativePosition on the y axis for the element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

textContent

\n
\n

string

\n

Text content of the element.

\n
\n \n
\n
\n
\n
\n
\n

userLocator

\n
\n

object

\n

User locator to find the element.

\n
\n
\n
\n
\n
\n

failTestOnCannotLocate

\n
\n

boolean

\n

Whether if the the test should fail if the element cannot be found.

\n
\n \n
\n
\n
\n
\n
\n

values

\n
\n

[object]

\n

Values of the user locator.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of a user locator. \nAllowed enum values: accessibility-id,id,ios-predicate-string,ios-class-chain,xpath

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Value of a user locator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

viewName

\n
\n

string

\n

Name of the view of the element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enable

\n
\n

boolean

\n

Boolean to change the state of the wifi for a toggleWiFi step type.

\n
\n \n
\n
\n
\n
\n
\n

maxScrolls

\n
\n

int64

\n

Maximum number of scrolls to do for a scrollToElement step type.

\n
\n \n
\n
\n
\n
\n
\n

positions

\n
\n

[object]

\n

List of positions for the flick step type. The maximum is 10 flicks per step

\n
\n
\n
\n
\n
\n

x

\n
\n

int64

\n

The x position for the flick.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

int64

\n

The y position for the flick.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtestPublicId

\n
\n

string

\n

Public ID of the test to be played as part of a playSubTest step type.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Values used in the step. Used in multiple step types.

\n
\n \n
\n
\n
\n
\n
\n

variable

\n
\n

object

\n

Variable object for extractVariable step type.

\n
\n
\n
\n
\n
\n

example [required]

\n
\n

string

\n

An example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The variable name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

withEnter

\n
\n

boolean

\n

Boolean to indicate if Enter should be pressed at the end of the typeText step type.

\n
\n \n
\n
\n
\n
\n
\n

x

\n
\n

int64

\n

Amount to scroll by on the x axis for a scroll step type.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

int64

\n

Amount to scroll by on the y axis for a scroll step type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

publicId

\n
\n

string

\n

The public ID 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 [required]

\n
\n

enum

\n

Step type used in your mobile Synthetic test. \nAllowed enum values: assertElementContent,assertScreenContains,assertScreenLacks,doubleTap,extractVariable,flick,openDeeplink,playSubTest,pressBack,restartApplication,rotate,scroll,scrollToElement,tap,toggleWiFi,typeText,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, mobile. \nAllowed enum values: mobile

default: mobile

\n
\n \n
\n
" }, "400": { "json": { @@ -3439,16 +3581,45 @@ "options": { "ci": { "executionRule": "blocking" - } + }, + "device_ids": [ + "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16" + ], + "mobileApplication": { + "applicationId": "00000000-0000-0000-0000-aaaaaaaaaaaa", + "referenceId": "00000000-0000-0000-0000-aaaaaaaaaaab", + "referenceType": "latest" + }, + "scheduling": { + "timeframes": [ + { + "day": 1, + "from": "07:00", + "to": "16:00" + } + ], + "timezone": "America/New_York" + }, + "tick_every": 300 }, + "steps": [ + { + "name": "", + "params": { + "variable": { + "example": "", + "name": "VAR_NAME" + } + }, + "type": "assertElementContent" + } + ], "type": "mobile" }, "json": { "config": { "initialApplicationArguments": { - "propertyNames": { - "pattern": "^(?!_dd).*$" - } + "": "string" }, "variables": [ { @@ -3470,10 +3641,8 @@ "allowApplicationCrash": false, "bindings": [ { - "items": { - "principals": [], - "role": "string" - } + "principals": [], + "relation": "string" } ], "ci": { @@ -3486,9 +3655,9 @@ "disableAutoAcceptAlert": false, "min_failure_duration": "integer", "mobileApplication": { - "applicationId": "string", - "referenceId": "string", - "referenceType": "string" + "applicationId": "00000000-0000-0000-0000-aaaaaaaaaaaa", + "referenceId": "00000000-0000-0000-0000-aaaaaaaaaaab", + "referenceType": "latest" }, "monitor_name": "string", "monitor_options": { @@ -3516,7 +3685,7 @@ ], "timezone": "America/New_York" }, - "tick_every": "integer", + "tick_every": 300, "verbosity": "integer" }, "status": "live", @@ -3525,9 +3694,51 @@ "allowFailure": false, "hasNewStepElement": false, "isCritical": false, - "name": "string", + "name": "", "noScreenshot": false, - "params": {}, + "params": { + "check": "string", + "delay": "integer", + "direction": "string", + "element": { + "context": "string", + "contextType": "string", + "elementDescription": "string", + "multiLocator": {}, + "relativePosition": { + "x": "integer", + "y": "integer" + }, + "textContent": "string", + "userLocator": { + "failTestOnCannotLocate": false, + "values": [ + { + "type": "string", + "value": "string" + } + ] + }, + "viewName": "string" + }, + "enable": false, + "maxScrolls": "integer", + "positions": [ + { + "x": "integer", + "y": "integer" + } + ], + "subtestPublicId": "string", + "value": "string", + "variable": { + "example": "", + "name": "VAR_NAME" + }, + "withEnter": false, + "x": "integer", + "y": "integer" + }, "publicId": "pub-lic-id0", "timeout": "integer", "type": "assertElementContent" @@ -3538,7 +3749,7 @@ ], "type": "mobile" }, - "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic mobile test.

\n
\n
\n
\n
\n
\n

initialApplicationArguments

\n
\n

object

\n

Initial application arguments for a mobile test.

\n
\n
\n
\n
\n
\n

propertyNames

\n
\n

object

\n

Name of the property.

\n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

The propertyNames pattern.

\n
\n \n
\n
\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 of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

The SyntheticsMobileTest device_ids.

\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 [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

allowApplicationCrash

\n
\n

boolean

\n

The SyntheticsMobileTestOptions allowApplicationCrash.

\n
\n \n
\n
\n
\n
\n
\n

bindings

\n
\n

[object]

\n

Array of bindings used for the mobile test.

\n
\n
\n
\n
\n
\n

items

\n
\n

object

\n

Object describing the binding used for a mobile test.

\n
\n
\n
\n
\n
\n

principals

\n
\n

[string]

\n

List of principals for a mobile test binding.

\n
\n \n
\n
\n
\n
\n
\n

role

\n
\n

enum

\n

The definition of SyntheticsMobileTestBindingItemsRole object. \nAllowed enum values: editor,viewer

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

defaultStepTimeout

\n
\n

int32

\n

The SyntheticsMobileTestOptions defaultStepTimeout.

\n
\n \n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For mobile test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableAutoAcceptAlert

\n
\n

boolean

\n

The SyntheticsMobileTestOptions disableAutoAcceptAlert.

\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

mobileApplication

\n
\n

object

\n

Mobile application for mobile synthetics test.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

Application ID of the mobile application.

\n
\n \n
\n
\n
\n
\n
\n

referenceId

\n
\n

string

\n

Reference ID of the mobile application.

\n
\n \n
\n
\n
\n
\n
\n

referenceType

\n
\n

enum

\n

Reference type for the mobile application for a mobile synthetics test. \nAllowed enum values: latest,version

\n
\n \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 mobile Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The definition of SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName object. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The SyntheticsMobileTestOptionsMonitorOptions renotify_occurrences.

\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

The SyntheticsMobileTestOptions noScreenshot.

\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

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

verbosity

\n
\n

int32

\n

The SyntheticsMobileTestOptions verbosity.

\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

hasNewStepElement

\n
\n

boolean

\n

A boolean set to determine if the step has a new step element.

\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 mobile step.

\n
\n \n
\n
\n
\n
\n
\n

publicId

\n
\n

string

\n

The public ID 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 mobile Synthetic test. \nAllowed enum values: assertElementContent,assertScreenContains,assertScreenLacks,doubleTap,extractVariable,flick,openDeeplink,playSubTest,pressBack,restartApplication,rotate,scroll,scrollToElement,tap,toggleWiFi,typeText,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, mobile. \nAllowed enum values: mobile

default: mobile

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic mobile test.

\n
\n
\n
\n
\n
\n

initialApplicationArguments

\n
\n

object

\n

Initial application arguments for a mobile test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single application argument.

\n
\n \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 of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

Array with the different device IDs 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 [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

allowApplicationCrash

\n
\n

boolean

\n

A boolean to set if an application crash would mark the test as failed.

\n
\n \n
\n
\n
\n
\n
\n

bindings

\n
\n

[object]

\n

Array of bindings used for the mobile test.

\n
\n
\n
\n
\n
\n

principals

\n
\n

[string]

\n

List of principals for a mobile test binding.

\n
\n \n
\n
\n
\n
\n
\n

relation

\n
\n

enum

\n

The type of relation for the binding. \nAllowed enum values: editor,viewer

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

defaultStepTimeout

\n
\n

int32

\n

The default timeout for steps in the test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n

device_ids [required]

\n
\n

[string]

\n

For mobile test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableAutoAcceptAlert

\n
\n

boolean

\n

A boolean to disable auto accepting alerts.

\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

mobileApplication [required]

\n
\n

object

\n

Mobile application for mobile synthetics test.

\n
\n
\n
\n
\n
\n

applicationId [required]

\n
\n

string

\n

Application ID of the mobile application.

\n
\n \n
\n
\n
\n
\n
\n

referenceId [required]

\n
\n

string

\n

Reference ID of the mobile application.

\n
\n \n
\n
\n
\n
\n
\n

referenceType [required]

\n
\n

enum

\n

Reference type for the mobile application for a mobile synthetics test. \nAllowed enum values: latest,version

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

\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

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every [required]

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n

verbosity

\n
\n

int32

\n

The level of verbosity for the mobile test.

\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

hasNewStepElement

\n
\n

boolean

\n

A boolean set to determine if the step has a new step element.

\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 [required]

\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 [required]

\n
\n

object

\n

The parameters of a mobile step.

\n
\n
\n
\n
\n
\n

check

\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

delay

\n
\n

int64

\n

Number of milliseconds to wait between inputs in a typeText step type.

\n
\n \n
\n
\n
\n
\n
\n

direction

\n
\n

enum

\n

The direction of the scroll for a scrollToElement step type. \nAllowed enum values: up,down,left,right

\n
\n \n
\n
\n
\n
\n
\n

element

\n
\n

object

\n

Information about the element used for a step.

\n
\n
\n
\n
\n
\n

context

\n
\n

string

\n

Context of the element.

\n
\n \n
\n
\n
\n
\n
\n

contextType

\n
\n

enum

\n

Type of the context that the element is in. \nAllowed enum values: native,web

\n
\n \n
\n
\n
\n
\n
\n

elementDescription

\n
\n

string

\n

Description of the element.

\n
\n \n
\n
\n
\n
\n
\n

multiLocator

\n
\n

object

\n

Multi-locator to find the element.

\n
\n \n
\n
\n
\n
\n
\n

relativePosition

\n
\n

object

\n

Position of the action relative to the element.

\n
\n
\n
\n
\n
\n

x

\n
\n

int64

\n

The relativePosition on the x axis for the element.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

int64

\n

The relativePosition on the y axis for the element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

textContent

\n
\n

string

\n

Text content of the element.

\n
\n \n
\n
\n
\n
\n
\n

userLocator

\n
\n

object

\n

User locator to find the element.

\n
\n
\n
\n
\n
\n

failTestOnCannotLocate

\n
\n

boolean

\n

Whether if the the test should fail if the element cannot be found.

\n
\n \n
\n
\n
\n
\n
\n

values

\n
\n

[object]

\n

Values of the user locator.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of a user locator. \nAllowed enum values: accessibility-id,id,ios-predicate-string,ios-class-chain,xpath

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Value of a user locator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

viewName

\n
\n

string

\n

Name of the view of the element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enable

\n
\n

boolean

\n

Boolean to change the state of the wifi for a toggleWiFi step type.

\n
\n \n
\n
\n
\n
\n
\n

maxScrolls

\n
\n

int64

\n

Maximum number of scrolls to do for a scrollToElement step type.

\n
\n \n
\n
\n
\n
\n
\n

positions

\n
\n

[object]

\n

List of positions for the flick step type. The maximum is 10 flicks per step

\n
\n
\n
\n
\n
\n

x

\n
\n

int64

\n

The x position for the flick.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

int64

\n

The y position for the flick.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtestPublicId

\n
\n

string

\n

Public ID of the test to be played as part of a playSubTest step type.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Values used in the step. Used in multiple step types.

\n
\n \n
\n
\n
\n
\n
\n

variable

\n
\n

object

\n

Variable object for extractVariable step type.

\n
\n
\n
\n
\n
\n

example [required]

\n
\n

string

\n

An example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The variable name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

withEnter

\n
\n

boolean

\n

Boolean to indicate if Enter should be pressed at the end of the typeText step type.

\n
\n \n
\n
\n
\n
\n
\n

x

\n
\n

int64

\n

Amount to scroll by on the x axis for a scroll step type.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

int64

\n

Amount to scroll by on the y axis for a scroll step type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

publicId

\n
\n

string

\n

The public ID 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 [required]

\n
\n

enum

\n

Step type used in your mobile Synthetic test. \nAllowed enum values: assertElementContent,assertScreenContains,assertScreenLacks,doubleTap,extractVariable,flick,openDeeplink,playSubTest,pressBack,restartApplication,rotate,scroll,scrollToElement,tap,toggleWiFi,typeText,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, mobile. \nAllowed enum values: mobile

default: mobile

\n
\n \n
\n
" } }, "GetMobileTest": { @@ -3547,9 +3758,7 @@ "json": { "config": { "initialApplicationArguments": { - "propertyNames": { - "pattern": "^(?!_dd).*$" - } + "": "string" }, "variables": [ { @@ -3572,10 +3781,8 @@ "allowApplicationCrash": false, "bindings": [ { - "items": { - "principals": [], - "role": "string" - } + "principals": [], + "relation": "string" } ], "ci": { @@ -3588,9 +3795,9 @@ "disableAutoAcceptAlert": false, "min_failure_duration": "integer", "mobileApplication": { - "applicationId": "string", - "referenceId": "string", - "referenceType": "string" + "applicationId": "00000000-0000-0000-0000-aaaaaaaaaaaa", + "referenceId": "00000000-0000-0000-0000-aaaaaaaaaaab", + "referenceType": "latest" }, "monitor_name": "string", "monitor_options": { @@ -3618,7 +3825,7 @@ ], "timezone": "America/New_York" }, - "tick_every": "integer", + "tick_every": 300, "verbosity": "integer" }, "public_id": "123-abc-456", @@ -3628,9 +3835,51 @@ "allowFailure": false, "hasNewStepElement": false, "isCritical": false, - "name": "string", + "name": "", "noScreenshot": false, - "params": {}, + "params": { + "check": "string", + "delay": "integer", + "direction": "string", + "element": { + "context": "string", + "contextType": "string", + "elementDescription": "string", + "multiLocator": {}, + "relativePosition": { + "x": "integer", + "y": "integer" + }, + "textContent": "string", + "userLocator": { + "failTestOnCannotLocate": false, + "values": [ + { + "type": "string", + "value": "string" + } + ] + }, + "viewName": "string" + }, + "enable": false, + "maxScrolls": "integer", + "positions": [ + { + "x": "integer", + "y": "integer" + } + ], + "subtestPublicId": "string", + "value": "string", + "variable": { + "example": "", + "name": "VAR_NAME" + }, + "withEnter": false, + "x": "integer", + "y": "integer" + }, "publicId": "pub-lic-id0", "timeout": "integer", "type": "assertElementContent" @@ -3641,7 +3890,7 @@ ], "type": "mobile" }, - "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic mobile test.

\n
\n
\n
\n
\n
\n

initialApplicationArguments

\n
\n

object

\n

Initial application arguments for a mobile test.

\n
\n
\n
\n
\n
\n

propertyNames

\n
\n

object

\n

Name of the property.

\n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

The propertyNames pattern.

\n
\n \n
\n
\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 of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

The SyntheticsMobileTest device_ids.

\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 [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

allowApplicationCrash

\n
\n

boolean

\n

The SyntheticsMobileTestOptions allowApplicationCrash.

\n
\n \n
\n
\n
\n
\n
\n

bindings

\n
\n

[object]

\n

Array of bindings used for the mobile test.

\n
\n
\n
\n
\n
\n

items

\n
\n

object

\n

Object describing the binding used for a mobile test.

\n
\n
\n
\n
\n
\n

principals

\n
\n

[string]

\n

List of principals for a mobile test binding.

\n
\n \n
\n
\n
\n
\n
\n

role

\n
\n

enum

\n

The definition of SyntheticsMobileTestBindingItemsRole object. \nAllowed enum values: editor,viewer

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

defaultStepTimeout

\n
\n

int32

\n

The SyntheticsMobileTestOptions defaultStepTimeout.

\n
\n \n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For mobile test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableAutoAcceptAlert

\n
\n

boolean

\n

The SyntheticsMobileTestOptions disableAutoAcceptAlert.

\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

mobileApplication

\n
\n

object

\n

Mobile application for mobile synthetics test.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

Application ID of the mobile application.

\n
\n \n
\n
\n
\n
\n
\n

referenceId

\n
\n

string

\n

Reference ID of the mobile application.

\n
\n \n
\n
\n
\n
\n
\n

referenceType

\n
\n

enum

\n

Reference type for the mobile application for a mobile synthetics test. \nAllowed enum values: latest,version

\n
\n \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 mobile Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The definition of SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName object. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The SyntheticsMobileTestOptionsMonitorOptions renotify_occurrences.

\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

The SyntheticsMobileTestOptions noScreenshot.

\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

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

verbosity

\n
\n

int32

\n

The SyntheticsMobileTestOptions verbosity.

\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

hasNewStepElement

\n
\n

boolean

\n

A boolean set to determine if the step has a new step element.

\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 mobile step.

\n
\n \n
\n
\n
\n
\n
\n

publicId

\n
\n

string

\n

The public ID 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 mobile Synthetic test. \nAllowed enum values: assertElementContent,assertScreenContains,assertScreenLacks,doubleTap,extractVariable,flick,openDeeplink,playSubTest,pressBack,restartApplication,rotate,scroll,scrollToElement,tap,toggleWiFi,typeText,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, mobile. \nAllowed enum values: mobile

default: mobile

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic mobile test.

\n
\n
\n
\n
\n
\n

initialApplicationArguments

\n
\n

object

\n

Initial application arguments for a mobile test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single application argument.

\n
\n \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 of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

Array with the different device IDs 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 [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

allowApplicationCrash

\n
\n

boolean

\n

A boolean to set if an application crash would mark the test as failed.

\n
\n \n
\n
\n
\n
\n
\n

bindings

\n
\n

[object]

\n

Array of bindings used for the mobile test.

\n
\n
\n
\n
\n
\n

principals

\n
\n

[string]

\n

List of principals for a mobile test binding.

\n
\n \n
\n
\n
\n
\n
\n

relation

\n
\n

enum

\n

The type of relation for the binding. \nAllowed enum values: editor,viewer

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

defaultStepTimeout

\n
\n

int32

\n

The default timeout for steps in the test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n

device_ids [required]

\n
\n

[string]

\n

For mobile test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableAutoAcceptAlert

\n
\n

boolean

\n

A boolean to disable auto accepting alerts.

\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

mobileApplication [required]

\n
\n

object

\n

Mobile application for mobile synthetics test.

\n
\n
\n
\n
\n
\n

applicationId [required]

\n
\n

string

\n

Application ID of the mobile application.

\n
\n \n
\n
\n
\n
\n
\n

referenceId [required]

\n
\n

string

\n

Reference ID of the mobile application.

\n
\n \n
\n
\n
\n
\n
\n

referenceType [required]

\n
\n

enum

\n

Reference type for the mobile application for a mobile synthetics test. \nAllowed enum values: latest,version

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

\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

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every [required]

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n

verbosity

\n
\n

int32

\n

The level of verbosity for the mobile test.

\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

hasNewStepElement

\n
\n

boolean

\n

A boolean set to determine if the step has a new step element.

\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 [required]

\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 [required]

\n
\n

object

\n

The parameters of a mobile step.

\n
\n
\n
\n
\n
\n

check

\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

delay

\n
\n

int64

\n

Number of milliseconds to wait between inputs in a typeText step type.

\n
\n \n
\n
\n
\n
\n
\n

direction

\n
\n

enum

\n

The direction of the scroll for a scrollToElement step type. \nAllowed enum values: up,down,left,right

\n
\n \n
\n
\n
\n
\n
\n

element

\n
\n

object

\n

Information about the element used for a step.

\n
\n
\n
\n
\n
\n

context

\n
\n

string

\n

Context of the element.

\n
\n \n
\n
\n
\n
\n
\n

contextType

\n
\n

enum

\n

Type of the context that the element is in. \nAllowed enum values: native,web

\n
\n \n
\n
\n
\n
\n
\n

elementDescription

\n
\n

string

\n

Description of the element.

\n
\n \n
\n
\n
\n
\n
\n

multiLocator

\n
\n

object

\n

Multi-locator to find the element.

\n
\n \n
\n
\n
\n
\n
\n

relativePosition

\n
\n

object

\n

Position of the action relative to the element.

\n
\n
\n
\n
\n
\n

x

\n
\n

int64

\n

The relativePosition on the x axis for the element.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

int64

\n

The relativePosition on the y axis for the element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

textContent

\n
\n

string

\n

Text content of the element.

\n
\n \n
\n
\n
\n
\n
\n

userLocator

\n
\n

object

\n

User locator to find the element.

\n
\n
\n
\n
\n
\n

failTestOnCannotLocate

\n
\n

boolean

\n

Whether if the the test should fail if the element cannot be found.

\n
\n \n
\n
\n
\n
\n
\n

values

\n
\n

[object]

\n

Values of the user locator.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of a user locator. \nAllowed enum values: accessibility-id,id,ios-predicate-string,ios-class-chain,xpath

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Value of a user locator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

viewName

\n
\n

string

\n

Name of the view of the element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enable

\n
\n

boolean

\n

Boolean to change the state of the wifi for a toggleWiFi step type.

\n
\n \n
\n
\n
\n
\n
\n

maxScrolls

\n
\n

int64

\n

Maximum number of scrolls to do for a scrollToElement step type.

\n
\n \n
\n
\n
\n
\n
\n

positions

\n
\n

[object]

\n

List of positions for the flick step type. The maximum is 10 flicks per step

\n
\n
\n
\n
\n
\n

x

\n
\n

int64

\n

The x position for the flick.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

int64

\n

The y position for the flick.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtestPublicId

\n
\n

string

\n

Public ID of the test to be played as part of a playSubTest step type.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Values used in the step. Used in multiple step types.

\n
\n \n
\n
\n
\n
\n
\n

variable

\n
\n

object

\n

Variable object for extractVariable step type.

\n
\n
\n
\n
\n
\n

example [required]

\n
\n

string

\n

An example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The variable name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

withEnter

\n
\n

boolean

\n

Boolean to indicate if Enter should be pressed at the end of the typeText step type.

\n
\n \n
\n
\n
\n
\n
\n

x

\n
\n

int64

\n

Amount to scroll by on the x axis for a scroll step type.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

int64

\n

Amount to scroll by on the y axis for a scroll step type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

publicId

\n
\n

string

\n

The public ID 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 [required]

\n
\n

enum

\n

Step type used in your mobile Synthetic test. \nAllowed enum values: assertElementContent,assertScreenContains,assertScreenLacks,doubleTap,extractVariable,flick,openDeeplink,playSubTest,pressBack,restartApplication,rotate,scroll,scrollToElement,tap,toggleWiFi,typeText,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, mobile. \nAllowed enum values: mobile

default: mobile

\n
\n \n
\n
" }, "403": { "json": { @@ -3680,9 +3929,7 @@ "json": { "config": { "initialApplicationArguments": { - "propertyNames": { - "pattern": "^(?!_dd).*$" - } + "": "string" }, "variables": [ { @@ -3705,10 +3952,8 @@ "allowApplicationCrash": false, "bindings": [ { - "items": { - "principals": [], - "role": "string" - } + "principals": [], + "relation": "string" } ], "ci": { @@ -3721,9 +3966,9 @@ "disableAutoAcceptAlert": false, "min_failure_duration": "integer", "mobileApplication": { - "applicationId": "string", - "referenceId": "string", - "referenceType": "string" + "applicationId": "00000000-0000-0000-0000-aaaaaaaaaaaa", + "referenceId": "00000000-0000-0000-0000-aaaaaaaaaaab", + "referenceType": "latest" }, "monitor_name": "string", "monitor_options": { @@ -3751,7 +3996,7 @@ ], "timezone": "America/New_York" }, - "tick_every": "integer", + "tick_every": 300, "verbosity": "integer" }, "public_id": "123-abc-456", @@ -3761,9 +4006,51 @@ "allowFailure": false, "hasNewStepElement": false, "isCritical": false, - "name": "string", + "name": "", "noScreenshot": false, - "params": {}, + "params": { + "check": "string", + "delay": "integer", + "direction": "string", + "element": { + "context": "string", + "contextType": "string", + "elementDescription": "string", + "multiLocator": {}, + "relativePosition": { + "x": "integer", + "y": "integer" + }, + "textContent": "string", + "userLocator": { + "failTestOnCannotLocate": false, + "values": [ + { + "type": "string", + "value": "string" + } + ] + }, + "viewName": "string" + }, + "enable": false, + "maxScrolls": "integer", + "positions": [ + { + "x": "integer", + "y": "integer" + } + ], + "subtestPublicId": "string", + "value": "string", + "variable": { + "example": "", + "name": "VAR_NAME" + }, + "withEnter": false, + "x": "integer", + "y": "integer" + }, "publicId": "pub-lic-id0", "timeout": "integer", "type": "assertElementContent" @@ -3774,7 +4061,7 @@ ], "type": "mobile" }, - "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic mobile test.

\n
\n
\n
\n
\n
\n

initialApplicationArguments

\n
\n

object

\n

Initial application arguments for a mobile test.

\n
\n
\n
\n
\n
\n

propertyNames

\n
\n

object

\n

Name of the property.

\n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

The propertyNames pattern.

\n
\n \n
\n
\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 of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

The SyntheticsMobileTest device_ids.

\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 [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

allowApplicationCrash

\n
\n

boolean

\n

The SyntheticsMobileTestOptions allowApplicationCrash.

\n
\n \n
\n
\n
\n
\n
\n

bindings

\n
\n

[object]

\n

Array of bindings used for the mobile test.

\n
\n
\n
\n
\n
\n

items

\n
\n

object

\n

Object describing the binding used for a mobile test.

\n
\n
\n
\n
\n
\n

principals

\n
\n

[string]

\n

List of principals for a mobile test binding.

\n
\n \n
\n
\n
\n
\n
\n

role

\n
\n

enum

\n

The definition of SyntheticsMobileTestBindingItemsRole object. \nAllowed enum values: editor,viewer

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

defaultStepTimeout

\n
\n

int32

\n

The SyntheticsMobileTestOptions defaultStepTimeout.

\n
\n \n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For mobile test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableAutoAcceptAlert

\n
\n

boolean

\n

The SyntheticsMobileTestOptions disableAutoAcceptAlert.

\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

mobileApplication

\n
\n

object

\n

Mobile application for mobile synthetics test.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

Application ID of the mobile application.

\n
\n \n
\n
\n
\n
\n
\n

referenceId

\n
\n

string

\n

Reference ID of the mobile application.

\n
\n \n
\n
\n
\n
\n
\n

referenceType

\n
\n

enum

\n

Reference type for the mobile application for a mobile synthetics test. \nAllowed enum values: latest,version

\n
\n \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 mobile Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The definition of SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName object. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The SyntheticsMobileTestOptionsMonitorOptions renotify_occurrences.

\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

The SyntheticsMobileTestOptions noScreenshot.

\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

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

verbosity

\n
\n

int32

\n

The SyntheticsMobileTestOptions verbosity.

\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

hasNewStepElement

\n
\n

boolean

\n

A boolean set to determine if the step has a new step element.

\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 mobile step.

\n
\n \n
\n
\n
\n
\n
\n

publicId

\n
\n

string

\n

The public ID 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 mobile Synthetic test. \nAllowed enum values: assertElementContent,assertScreenContains,assertScreenLacks,doubleTap,extractVariable,flick,openDeeplink,playSubTest,pressBack,restartApplication,rotate,scroll,scrollToElement,tap,toggleWiFi,typeText,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, mobile. \nAllowed enum values: mobile

default: mobile

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic mobile test.

\n
\n
\n
\n
\n
\n

initialApplicationArguments

\n
\n

object

\n

Initial application arguments for a mobile test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single application argument.

\n
\n \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 of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

Array with the different device IDs 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 [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

allowApplicationCrash

\n
\n

boolean

\n

A boolean to set if an application crash would mark the test as failed.

\n
\n \n
\n
\n
\n
\n
\n

bindings

\n
\n

[object]

\n

Array of bindings used for the mobile test.

\n
\n
\n
\n
\n
\n

principals

\n
\n

[string]

\n

List of principals for a mobile test binding.

\n
\n \n
\n
\n
\n
\n
\n

relation

\n
\n

enum

\n

The type of relation for the binding. \nAllowed enum values: editor,viewer

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

defaultStepTimeout

\n
\n

int32

\n

The default timeout for steps in the test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n

device_ids [required]

\n
\n

[string]

\n

For mobile test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableAutoAcceptAlert

\n
\n

boolean

\n

A boolean to disable auto accepting alerts.

\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

mobileApplication [required]

\n
\n

object

\n

Mobile application for mobile synthetics test.

\n
\n
\n
\n
\n
\n

applicationId [required]

\n
\n

string

\n

Application ID of the mobile application.

\n
\n \n
\n
\n
\n
\n
\n

referenceId [required]

\n
\n

string

\n

Reference ID of the mobile application.

\n
\n \n
\n
\n
\n
\n
\n

referenceType [required]

\n
\n

enum

\n

Reference type for the mobile application for a mobile synthetics test. \nAllowed enum values: latest,version

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

\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

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every [required]

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n

verbosity

\n
\n

int32

\n

The level of verbosity for the mobile test.

\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

hasNewStepElement

\n
\n

boolean

\n

A boolean set to determine if the step has a new step element.

\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 [required]

\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 [required]

\n
\n

object

\n

The parameters of a mobile step.

\n
\n
\n
\n
\n
\n

check

\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

delay

\n
\n

int64

\n

Number of milliseconds to wait between inputs in a typeText step type.

\n
\n \n
\n
\n
\n
\n
\n

direction

\n
\n

enum

\n

The direction of the scroll for a scrollToElement step type. \nAllowed enum values: up,down,left,right

\n
\n \n
\n
\n
\n
\n
\n

element

\n
\n

object

\n

Information about the element used for a step.

\n
\n
\n
\n
\n
\n

context

\n
\n

string

\n

Context of the element.

\n
\n \n
\n
\n
\n
\n
\n

contextType

\n
\n

enum

\n

Type of the context that the element is in. \nAllowed enum values: native,web

\n
\n \n
\n
\n
\n
\n
\n

elementDescription

\n
\n

string

\n

Description of the element.

\n
\n \n
\n
\n
\n
\n
\n

multiLocator

\n
\n

object

\n

Multi-locator to find the element.

\n
\n \n
\n
\n
\n
\n
\n

relativePosition

\n
\n

object

\n

Position of the action relative to the element.

\n
\n
\n
\n
\n
\n

x

\n
\n

int64

\n

The relativePosition on the x axis for the element.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

int64

\n

The relativePosition on the y axis for the element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

textContent

\n
\n

string

\n

Text content of the element.

\n
\n \n
\n
\n
\n
\n
\n

userLocator

\n
\n

object

\n

User locator to find the element.

\n
\n
\n
\n
\n
\n

failTestOnCannotLocate

\n
\n

boolean

\n

Whether if the the test should fail if the element cannot be found.

\n
\n \n
\n
\n
\n
\n
\n

values

\n
\n

[object]

\n

Values of the user locator.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of a user locator. \nAllowed enum values: accessibility-id,id,ios-predicate-string,ios-class-chain,xpath

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Value of a user locator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

viewName

\n
\n

string

\n

Name of the view of the element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enable

\n
\n

boolean

\n

Boolean to change the state of the wifi for a toggleWiFi step type.

\n
\n \n
\n
\n
\n
\n
\n

maxScrolls

\n
\n

int64

\n

Maximum number of scrolls to do for a scrollToElement step type.

\n
\n \n
\n
\n
\n
\n
\n

positions

\n
\n

[object]

\n

List of positions for the flick step type. The maximum is 10 flicks per step

\n
\n
\n
\n
\n
\n

x

\n
\n

int64

\n

The x position for the flick.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

int64

\n

The y position for the flick.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtestPublicId

\n
\n

string

\n

Public ID of the test to be played as part of a playSubTest step type.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Values used in the step. Used in multiple step types.

\n
\n \n
\n
\n
\n
\n
\n

variable

\n
\n

object

\n

Variable object for extractVariable step type.

\n
\n
\n
\n
\n
\n

example [required]

\n
\n

string

\n

An example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The variable name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

withEnter

\n
\n

boolean

\n

Boolean to indicate if Enter should be pressed at the end of the typeText step type.

\n
\n \n
\n
\n
\n
\n
\n

x

\n
\n

int64

\n

Amount to scroll by on the x axis for a scroll step type.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

int64

\n

Amount to scroll by on the y axis for a scroll step type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

publicId

\n
\n

string

\n

The public ID 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 [required]

\n
\n

enum

\n

Step type used in your mobile Synthetic test. \nAllowed enum values: assertElementContent,assertScreenContains,assertScreenLacks,doubleTap,extractVariable,flick,openDeeplink,playSubTest,pressBack,restartApplication,rotate,scroll,scrollToElement,tap,toggleWiFi,typeText,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, mobile. \nAllowed enum values: mobile

default: mobile

\n
\n \n
\n
" }, "400": { "json": { @@ -3823,16 +4110,45 @@ "options": { "ci": { "executionRule": "blocking" - } + }, + "device_ids": [ + "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16" + ], + "mobileApplication": { + "applicationId": "00000000-0000-0000-0000-aaaaaaaaaaaa", + "referenceId": "00000000-0000-0000-0000-aaaaaaaaaaab", + "referenceType": "latest" + }, + "scheduling": { + "timeframes": [ + { + "day": 1, + "from": "07:00", + "to": "16:00" + } + ], + "timezone": "America/New_York" + }, + "tick_every": 300 }, + "steps": [ + { + "name": "", + "params": { + "variable": { + "example": "", + "name": "VAR_NAME" + } + }, + "type": "assertElementContent" + } + ], "type": "mobile" }, "json": { "config": { "initialApplicationArguments": { - "propertyNames": { - "pattern": "^(?!_dd).*$" - } + "": "string" }, "variables": [ { @@ -3854,10 +4170,8 @@ "allowApplicationCrash": false, "bindings": [ { - "items": { - "principals": [], - "role": "string" - } + "principals": [], + "relation": "string" } ], "ci": { @@ -3870,9 +4184,9 @@ "disableAutoAcceptAlert": false, "min_failure_duration": "integer", "mobileApplication": { - "applicationId": "string", - "referenceId": "string", - "referenceType": "string" + "applicationId": "00000000-0000-0000-0000-aaaaaaaaaaaa", + "referenceId": "00000000-0000-0000-0000-aaaaaaaaaaab", + "referenceType": "latest" }, "monitor_name": "string", "monitor_options": { @@ -3900,7 +4214,7 @@ ], "timezone": "America/New_York" }, - "tick_every": "integer", + "tick_every": 300, "verbosity": "integer" }, "status": "live", @@ -3909,9 +4223,51 @@ "allowFailure": false, "hasNewStepElement": false, "isCritical": false, - "name": "string", + "name": "", "noScreenshot": false, - "params": {}, + "params": { + "check": "string", + "delay": "integer", + "direction": "string", + "element": { + "context": "string", + "contextType": "string", + "elementDescription": "string", + "multiLocator": {}, + "relativePosition": { + "x": "integer", + "y": "integer" + }, + "textContent": "string", + "userLocator": { + "failTestOnCannotLocate": false, + "values": [ + { + "type": "string", + "value": "string" + } + ] + }, + "viewName": "string" + }, + "enable": false, + "maxScrolls": "integer", + "positions": [ + { + "x": "integer", + "y": "integer" + } + ], + "subtestPublicId": "string", + "value": "string", + "variable": { + "example": "", + "name": "VAR_NAME" + }, + "withEnter": false, + "x": "integer", + "y": "integer" + }, "publicId": "pub-lic-id0", "timeout": "integer", "type": "assertElementContent" @@ -3922,7 +4278,7 @@ ], "type": "mobile" }, - "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic mobile test.

\n
\n
\n
\n
\n
\n

initialApplicationArguments

\n
\n

object

\n

Initial application arguments for a mobile test.

\n
\n
\n
\n
\n
\n

propertyNames

\n
\n

object

\n

Name of the property.

\n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

The propertyNames pattern.

\n
\n \n
\n
\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 of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

The SyntheticsMobileTest device_ids.

\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 [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

allowApplicationCrash

\n
\n

boolean

\n

The SyntheticsMobileTestOptions allowApplicationCrash.

\n
\n \n
\n
\n
\n
\n
\n

bindings

\n
\n

[object]

\n

Array of bindings used for the mobile test.

\n
\n
\n
\n
\n
\n

items

\n
\n

object

\n

Object describing the binding used for a mobile test.

\n
\n
\n
\n
\n
\n

principals

\n
\n

[string]

\n

List of principals for a mobile test binding.

\n
\n \n
\n
\n
\n
\n
\n

role

\n
\n

enum

\n

The definition of SyntheticsMobileTestBindingItemsRole object. \nAllowed enum values: editor,viewer

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

defaultStepTimeout

\n
\n

int32

\n

The SyntheticsMobileTestOptions defaultStepTimeout.

\n
\n \n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For mobile test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableAutoAcceptAlert

\n
\n

boolean

\n

The SyntheticsMobileTestOptions disableAutoAcceptAlert.

\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

mobileApplication

\n
\n

object

\n

Mobile application for mobile synthetics test.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

Application ID of the mobile application.

\n
\n \n
\n
\n
\n
\n
\n

referenceId

\n
\n

string

\n

Reference ID of the mobile application.

\n
\n \n
\n
\n
\n
\n
\n

referenceType

\n
\n

enum

\n

Reference type for the mobile application for a mobile synthetics test. \nAllowed enum values: latest,version

\n
\n \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 mobile Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The definition of SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName object. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The SyntheticsMobileTestOptionsMonitorOptions renotify_occurrences.

\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

The SyntheticsMobileTestOptions noScreenshot.

\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

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

verbosity

\n
\n

int32

\n

The SyntheticsMobileTestOptions verbosity.

\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

hasNewStepElement

\n
\n

boolean

\n

A boolean set to determine if the step has a new step element.

\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 mobile step.

\n
\n \n
\n
\n
\n
\n
\n

publicId

\n
\n

string

\n

The public ID 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 mobile Synthetic test. \nAllowed enum values: assertElementContent,assertScreenContains,assertScreenLacks,doubleTap,extractVariable,flick,openDeeplink,playSubTest,pressBack,restartApplication,rotate,scroll,scrollToElement,tap,toggleWiFi,typeText,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, mobile. \nAllowed enum values: mobile

default: mobile

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

config [required]

\n
\n

object

\n

Configuration object for a Synthetic mobile test.

\n
\n
\n
\n
\n
\n

initialApplicationArguments

\n
\n

object

\n

Initial application arguments for a mobile test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single application argument.

\n
\n \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 of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

Array with the different device IDs 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 [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

allowApplicationCrash

\n
\n

boolean

\n

A boolean to set if an application crash would mark the test as failed.

\n
\n \n
\n
\n
\n
\n
\n

bindings

\n
\n

[object]

\n

Array of bindings used for the mobile test.

\n
\n
\n
\n
\n
\n

principals

\n
\n

[string]

\n

List of principals for a mobile test binding.

\n
\n \n
\n
\n
\n
\n
\n

relation

\n
\n

enum

\n

The type of relation for the binding. \nAllowed enum values: editor,viewer

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

ci

\n
\n

object

\n

CI/CD options for a Synthetic test.

\n
\n
\n
\n
\n
\n

executionRule [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

defaultStepTimeout

\n
\n

int32

\n

The default timeout for steps in the test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n

device_ids [required]

\n
\n

[string]

\n

For mobile test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableAutoAcceptAlert

\n
\n

boolean

\n

A boolean to disable auto accepting alerts.

\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

mobileApplication [required]

\n
\n

object

\n

Mobile application for mobile synthetics test.

\n
\n
\n
\n
\n
\n

applicationId [required]

\n
\n

string

\n

Application ID of the mobile application.

\n
\n \n
\n
\n
\n
\n
\n

referenceId [required]

\n
\n

string

\n

Reference ID of the mobile application.

\n
\n \n
\n
\n
\n
\n
\n

referenceType [required]

\n
\n

enum

\n

Reference type for the mobile application for a mobile synthetics test. \nAllowed enum values: latest,version

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

A boolean set to not take a screenshot for the step.

\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

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every [required]

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n

verbosity

\n
\n

int32

\n

The level of verbosity for the mobile test.

\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

hasNewStepElement

\n
\n

boolean

\n

A boolean set to determine if the step has a new step element.

\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 [required]

\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 [required]

\n
\n

object

\n

The parameters of a mobile step.

\n
\n
\n
\n
\n
\n

check

\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

delay

\n
\n

int64

\n

Number of milliseconds to wait between inputs in a typeText step type.

\n
\n \n
\n
\n
\n
\n
\n

direction

\n
\n

enum

\n

The direction of the scroll for a scrollToElement step type. \nAllowed enum values: up,down,left,right

\n
\n \n
\n
\n
\n
\n
\n

element

\n
\n

object

\n

Information about the element used for a step.

\n
\n
\n
\n
\n
\n

context

\n
\n

string

\n

Context of the element.

\n
\n \n
\n
\n
\n
\n
\n

contextType

\n
\n

enum

\n

Type of the context that the element is in. \nAllowed enum values: native,web

\n
\n \n
\n
\n
\n
\n
\n

elementDescription

\n
\n

string

\n

Description of the element.

\n
\n \n
\n
\n
\n
\n
\n

multiLocator

\n
\n

object

\n

Multi-locator to find the element.

\n
\n \n
\n
\n
\n
\n
\n

relativePosition

\n
\n

object

\n

Position of the action relative to the element.

\n
\n
\n
\n
\n
\n

x

\n
\n

int64

\n

The relativePosition on the x axis for the element.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

int64

\n

The relativePosition on the y axis for the element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

textContent

\n
\n

string

\n

Text content of the element.

\n
\n \n
\n
\n
\n
\n
\n

userLocator

\n
\n

object

\n

User locator to find the element.

\n
\n
\n
\n
\n
\n

failTestOnCannotLocate

\n
\n

boolean

\n

Whether if the the test should fail if the element cannot be found.

\n
\n \n
\n
\n
\n
\n
\n

values

\n
\n

[object]

\n

Values of the user locator.

\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of a user locator. \nAllowed enum values: accessibility-id,id,ios-predicate-string,ios-class-chain,xpath

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Value of a user locator.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

viewName

\n
\n

string

\n

Name of the view of the element.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

enable

\n
\n

boolean

\n

Boolean to change the state of the wifi for a toggleWiFi step type.

\n
\n \n
\n
\n
\n
\n
\n

maxScrolls

\n
\n

int64

\n

Maximum number of scrolls to do for a scrollToElement step type.

\n
\n \n
\n
\n
\n
\n
\n

positions

\n
\n

[object]

\n

List of positions for the flick step type. The maximum is 10 flicks per step

\n
\n
\n
\n
\n
\n

x

\n
\n

int64

\n

The x position for the flick.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

int64

\n

The y position for the flick.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

subtestPublicId

\n
\n

string

\n

Public ID of the test to be played as part of a playSubTest step type.

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

string

\n

Values used in the step. Used in multiple step types.

\n
\n \n
\n
\n
\n
\n
\n

variable

\n
\n

object

\n

Variable object for extractVariable step type.

\n
\n
\n
\n
\n
\n

example [required]

\n
\n

string

\n

An example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The variable name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

withEnter

\n
\n

boolean

\n

Boolean to indicate if Enter should be pressed at the end of the typeText step type.

\n
\n \n
\n
\n
\n
\n
\n

x

\n
\n

int64

\n

Amount to scroll by on the x axis for a scroll step type.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

int64

\n

Amount to scroll by on the y axis for a scroll step type.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

publicId

\n
\n

string

\n

The public ID 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 [required]

\n
\n

enum

\n

Step type used in your mobile Synthetic test. \nAllowed enum values: assertElementContent,assertScreenContains,assertScreenLacks,doubleTap,extractVariable,flick,openDeeplink,playSubTest,pressBack,restartApplication,rotate,scroll,scrollToElement,tap,toggleWiFi,typeText,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, mobile. \nAllowed enum values: mobile

default: mobile

\n
\n \n
\n
" } }, "TriggerTests": { @@ -4303,7 +4659,10 @@ "min_location_failed": "integer", "monitor_name": "string", "monitor_options": { - "renotify_interval": "integer" + "escalation_message": "string", + "notification_preset_name": "string", + "renotify_interval": "integer", + "renotify_occurrences": "integer" }, "monitor_priority": "integer", "noScreenshot": false, @@ -4348,7 +4707,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

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

\n
\n
\n
\n
\n
\n

example

\n
\n

string

\n

Example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

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,mobile

\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,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

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 [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:

\n

{ isEnabled: false }\nRUM data is not collected.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The 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,mobile

\n
\n \n
\n
" }, "403": { "json": { @@ -4518,7 +4877,10 @@ "min_location_failed": "integer", "monitor_name": "string", "monitor_options": { - "renotify_interval": "integer" + "escalation_message": "string", + "notification_preset_name": "string", + "renotify_interval": "integer", + "renotify_occurrences": "integer" }, "monitor_priority": "integer", "noScreenshot": false, @@ -4563,7 +4925,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

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

\n
\n
\n
\n
\n
\n

example

\n
\n

string

\n

Example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

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,mobile

\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,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

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 [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:

\n

{ isEnabled: false }\nRUM data is not collected.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The 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,mobile

\n
\n \n
\n
" }, "400": { "json": { @@ -4749,7 +5111,10 @@ "min_location_failed": "integer", "monitor_name": "string", "monitor_options": { - "renotify_interval": "integer" + "escalation_message": "string", + "notification_preset_name": "string", + "renotify_interval": "integer", + "renotify_occurrences": "integer" }, "monitor_priority": "integer", "noScreenshot": false, @@ -4794,7 +5159,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

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

\n
\n
\n
\n
\n
\n

example

\n
\n

string

\n

Example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

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,mobile

\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,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

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 [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:

\n

{ isEnabled: false }\nRUM data is not collected.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The 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,mobile

\n
\n \n
\n
" }, "400": { "json": { @@ -4851,8 +5216,21 @@ ] }, "options": { + "ci": { + "executionRule": "blocking" + }, "rumSettings": { "isEnabled": true + }, + "scheduling": { + "timeframes": [ + { + "day": 1, + "from": "07:00", + "to": "16:00" + } + ], + "timezone": "America/New_York" } } }, @@ -4984,7 +5362,10 @@ "min_location_failed": "integer", "monitor_name": "string", "monitor_options": { - "renotify_interval": "integer" + "escalation_message": "string", + "notification_preset_name": "string", + "renotify_interval": "integer", + "renotify_occurrences": "integer" }, "monitor_priority": "integer", "noScreenshot": false, @@ -5028,7 +5409,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

Option 6

\n
\n

object

\n

A JavaScript assertion.

\n
\n
\n
\n
\n
\n

code [required]

\n
\n

string

\n

The JavaScript code that performs the assertions.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the assertion. \nAllowed enum values: javascript

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

configVariables

\n
\n

[object]

\n

Array of variables used for the test.

\n
\n
\n
\n
\n
\n

example

\n
\n

string

\n

Example for the variable.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the variable for global variables.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the variable.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Pattern of the variable.

\n
\n \n
\n
\n
\n
\n
\n

secure

\n
\n

boolean

\n

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the configuration variable. \nAllowed enum values: global,text,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

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,mobile

\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,email

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request

\n
\n

object

\n

Object describing the Synthetic test request.

\n
\n
\n
\n
\n
\n

allow_insecure

\n
\n

boolean

\n

Allows loading insecure content for an HTTP request in a multistep test step.

\n
\n \n
\n
\n
\n
\n
\n

basicAuth

\n
\n

 <oneOf>

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Object to handle basic authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: web

default: web

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the basic authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Object to handle SIGV4 authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessKey [required]

\n
\n

string

\n

Access key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

region

\n
\n

string

\n

Region for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

secretKey [required]

\n
\n

string

\n

Secret key for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

serviceName

\n
\n

string

\n

Service name for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

sessionToken

\n
\n

string

\n

Session token for the SIGV4 authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: sigv4

default: sigv4

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

Object to handle NTLM authentication when performing the test.

\n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Domain for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

password

\n
\n

string

\n

Password for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of authentication to use when performing the test. \nAllowed enum values: ntlm

default: ntlm

\n
\n \n
\n
\n
\n
\n
\n

username

\n
\n

string

\n

Username for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

workstation

\n
\n

string

\n

Workstation for the authentication to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

Object to handle digest authentication when performing the test.

\n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: digest

default: digest

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use for the digest authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 5

\n
\n

object

\n

Object to handle oauth client authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId [required]

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret [required]

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-client

default: oauth-client

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 6

\n
\n

object

\n

Object to handle oauth rop authentication when performing the test.

\n
\n
\n
\n
\n
\n

accessTokenUrl [required]

\n
\n

string

\n

Access token URL to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

audience

\n
\n

string

\n

Audience to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientId

\n
\n

string

\n

Client ID to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

clientSecret

\n
\n

string

\n

Client secret to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

password [required]

\n
\n

string

\n

Password to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

resource

\n
\n

string

\n

Resource to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

string

\n

Scope to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n

tokenApiAuthentication [required]

\n
\n

enum

\n

Type of token to use when performing the authentication. \nAllowed enum values: header,body

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of basic authentication to use when performing the test. \nAllowed enum values: oauth-rop

default: oauth-rop

\n
\n \n
\n
\n
\n
\n
\n

username [required]

\n
\n

string

\n

Username to use when performing the authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

body

\n
\n

string

\n

Body to include in the test.

\n
\n \n
\n
\n
\n
\n
\n

bodyType

\n
\n

enum

\n

Type of the request body. \nAllowed enum values: text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data

\n
\n \n
\n
\n
\n
\n
\n

callType

\n
\n

enum

\n

The type of gRPC call to perform. \nAllowed enum values: healthcheck,unary

\n
\n \n
\n
\n
\n
\n
\n

certificate

\n
\n

object

\n

Client certificate to use when performing the test request.

\n
\n
\n
\n
\n
\n

cert

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

object

\n

Define a request certificate.

\n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

filename

\n
\n

string

\n

File name for the certificate or key.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

string

\n

Date of update of the certificate or key, ISO format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

certificateDomains

\n
\n

[string]

\n

By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificateDomains.

default:

\n
\n \n
\n
\n
\n
\n
\n

compressedJsonDescriptor

\n
\n

string

\n

A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

compressedProtoFile

\n
\n

string

\n

A protobuf file that needs to be gzipped first then base64 encoded.

\n
\n \n
\n
\n
\n
\n
\n

dnsServer

\n
\n

string

\n

DNS server to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

dnsServerPort

\n
\n

string

\n

DNS server port to use for DNS tests.

\n
\n \n
\n
\n
\n
\n
\n

files

\n
\n

[object]

\n

Files to be used as part of the request in the test.

\n
\n
\n
\n
\n
\n

bucketKey

\n
\n

string

\n

Bucket key of the file.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

string

\n

Content of the file.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the file.

\n
\n \n
\n
\n
\n
\n
\n

originalFileName

\n
\n

string

\n

Original name of the file.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

Size of the file.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

Specifies whether or not the request follows redirects.

\n
\n \n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

host

\n
\n

string

\n

Host name to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

Message to send for UDP or WebSocket tests.

\n
\n \n
\n
\n
\n
\n
\n

metadata

\n
\n

object

\n

Metadata to include when performing the gRPC test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single metadatum.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

method

\n
\n

string

\n

Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

\n
\n \n
\n
\n
\n
\n
\n

noSavingResponseBody

\n
\n

boolean

\n

Determines whether or not to save the response body.

\n
\n \n
\n
\n
\n
\n
\n

numberOfPackets

\n
\n

int32

\n

Number of pings to use per test.

\n
\n \n
\n
\n
\n
\n
\n

persistCookies

\n
\n

boolean

\n

Persist cookies across redirects.

\n
\n \n
\n
\n
\n
\n
\n

port

\n
\n

 <oneOf>

\n

Port to use when performing the test.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

int64

\n

Integer Port number to use when performing the test.

\n
\n \n
\n
\n
\n
\n
\n

Option 2

\n
\n

string

\n

String Port number to use when performing the test. Supports templated variables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

proxy

\n
\n

object

\n

The proxy to perform the test.

\n
\n
\n
\n
\n
\n

headers

\n
\n

object

\n

Headers to include when performing the test.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

string

\n

A single Header.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

url [required]

\n
\n

string

\n

URL of the proxy to perform the test.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query

\n
\n

object

\n

Query to use for the test.

\n
\n \n
\n
\n
\n
\n
\n

servername

\n
\n

string

\n

For SSL tests, it specifies on which server you want to initiate the TLS handshake,\nallowing the server to present one of multiple possible certificates on\nthe same IP address and TCP port number.

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

The gRPC service on which you want to perform the gRPC call.

\n
\n \n
\n
\n
\n
\n
\n

shouldTrackHops

\n
\n

boolean

\n

Turns on a traceroute probe to discover all gateways along the path to the host destination.

\n
\n \n
\n
\n
\n
\n
\n

timeout

\n
\n

double

\n

Timeout in seconds for the test.

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL to perform the test with.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

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 [required]

\n
\n

enum

\n

Execution rule for a Synthetic test. \nAllowed enum values: blocking,non_blocking,skipped

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

device_ids

\n
\n

[string]

\n

For browser test, array with the different device IDs used to run the test.

\n
\n \n
\n
\n
\n
\n
\n

disableCors

\n
\n

boolean

\n

Whether or not to disable CORS mechanism.

\n
\n \n
\n
\n
\n
\n
\n

disableCsp

\n
\n

boolean

\n

Disable Content Security Policy for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableProfiling

\n
\n

boolean

\n

Enable profiling for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

enableSecurityTesting

\n
\n

boolean

\n

DEPRECATED: Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.

\n
\n \n
\n
\n
\n
\n
\n

follow_redirects

\n
\n

boolean

\n

For API HTTP test, whether or not the test should follow redirects.

\n
\n \n
\n
\n
\n
\n
\n

httpVersion

\n
\n

enum

\n

HTTP version to use for a Synthetic test. \nAllowed enum values: http1,http2,any

\n
\n \n
\n
\n
\n
\n
\n

ignoreServerCertificateError

\n
\n

boolean

\n

Ignore server certificate error for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

initialNavigationTimeout

\n
\n

int64

\n

Timeout before declaring the initial step as failed (in seconds) for browser tests.

\n
\n \n
\n
\n
\n
\n
\n

min_failure_duration

\n
\n

int64

\n

Minimum amount of time in failure required to trigger an alert.

\n
\n \n
\n
\n
\n
\n
\n

min_location_failed

\n
\n

int64

\n

Minimum number of locations in failure required to trigger\nan alert.

\n
\n \n
\n
\n
\n
\n
\n

monitor_name

\n
\n

string

\n

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

\n
\n \n
\n
\n
\n
\n
\n

monitor_options

\n
\n

object

\n

Object containing the options for a Synthetic test as a monitor\n(for example, renotification).

\n
\n
\n
\n
\n
\n

escalation_message

\n
\n

string

\n

Message to include in the escalation notification.

\n
\n \n
\n
\n
\n
\n
\n

notification_preset_name

\n
\n

enum

\n

The name of the preset for the notification for the monitor. \nAllowed enum values: show_all,hide_all,hide_query,hide_handles

\n
\n \n
\n
\n
\n
\n
\n

renotify_interval

\n
\n

int64

\n

Time interval before renotifying if the test is still failing\n(in minutes).

\n
\n \n
\n
\n
\n
\n
\n

renotify_occurrences

\n
\n

int64

\n

The number of times to renotify if the test is still failing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

monitor_priority

\n
\n

int32

\n

Integer from 1 (high) to 5 (low) indicating alert severity.

\n
\n \n
\n
\n
\n
\n
\n

noScreenshot

\n
\n

boolean

\n

Prevents saving screenshots of the steps.

\n
\n \n
\n
\n
\n
\n
\n

restricted_roles

\n
\n

[string]

\n

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

\n
\n \n
\n
\n
\n
\n
\n

retry

\n
\n

object

\n

Object describing the retry strategy to apply to a Synthetic test.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

Number of times a test needs to be retried before marking a\nlocation as failed. Defaults to 0.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

double

\n

Time interval between retries (in milliseconds). Defaults to\n300ms.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rumSettings

\n
\n

object

\n

The RUM data collection settings for the Synthetic browser test.\nNote: There are 3 ways to format RUM settings:

\n

{ isEnabled: false }\nRUM data is not collected.

\n

{ isEnabled: true }\nRUM data is collected from the Synthetic test's default application.

\n

{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }\nRUM data is collected using the specified application.

\n
\n
\n
\n
\n
\n

applicationId

\n
\n

string

\n

RUM application ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

clientTokenId

\n
\n

int64

\n

RUM application API key ID used to collect RUM data for the browser test.

\n
\n \n
\n
\n
\n
\n
\n

isEnabled [required]

\n
\n

boolean

\n

Determines whether RUM data is collected during test runs.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

scheduling

\n
\n

object

\n

Object containing timeframes and timezone used for advanced scheduling.

\n
\n
\n
\n
\n
\n

timeframes [required]

\n
\n

[object]

\n

Array containing objects describing the scheduling pattern to apply to each day.

\n
\n
\n
\n
\n
\n

day [required]

\n
\n

int32

\n

Number representing the day of the week.

\n
\n \n
\n
\n
\n
\n
\n

from [required]

\n
\n

string

\n

The hour of the day on which scheduling starts.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

string

\n

The hour of the day on which scheduling ends.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

timezone [required]

\n
\n

string

\n

Timezone in which the timeframe is based.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tick_every

\n
\n

int64

\n

The frequency at which to run the Synthetic test (in seconds).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

public_id

\n
\n

string

\n

The 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,mobile

\n
\n \n
\n
" } }, "GetAPITestLatestResults": { diff --git a/content/en/database_monitoring/setup_mongodb/mongodbatlas.md b/content/en/database_monitoring/setup_mongodb/mongodbatlas.md index 2bcd8a337c0eb..507f2222710a4 100644 --- a/content/en/database_monitoring/setup_mongodb/mongodbatlas.md +++ b/content/en/database_monitoring/setup_mongodb/mongodbatlas.md @@ -39,8 +39,9 @@ The Datadog Agent requires read-only access to the MongoDB Atlas Cluster to coll 4. Add the following permissions to the custom role: - `read` on the `admin` database - `read` on the `local` database + - `read` on the `config` database (Sharded Cluster only) - `clusterMonitor` on the `admin` database - - `read` on the databases you want to monitor, or `readAnyDatabase` to monitor all databases + - `read` on the user created databases you want to monitor, or `readAnyDatabase` to monitor all databases 5. Click **Add Custom Role**. #### Create a monitoring user with the custom monitoring role diff --git a/content/en/ddsql_editor/reference/expressions_and_operators.md b/content/en/ddsql_editor/reference/expressions_and_operators.md index 0602fae33b994..8e4feecb11a3f 100644 --- a/content/en/ddsql_editor/reference/expressions_and_operators.md +++ b/content/en/ddsql_editor/reference/expressions_and_operators.md @@ -39,20 +39,27 @@ DDSQL implements the following comparison operators: For tag references and tag groups, the equality operator (`=`) is treated as a "contains" comparison. See the [Querying Tags in DDSQL][1] for more details. -Additionally, DDSQL supports the following SQL keywords, which function as standard boolean operators: +## SQL comparison keywords -- `NOT` -- `AND` -- `OR` +DDSQL supports the following SQL keywords, which function as standard Boolean operators: + +| Operator | Description | Example | Result | +|----------|------------------------|---------|--------| +| `NOT` | Filter records based on more than one condition. | `SELECT * FROM host WHERE NOT env = 'prod';` | Return all hosts that are not in the prod environment. | +| `AND` | Filter records based on more than one condition. | `SELECT * FROM host WHERE env = 'prod' AND cloud_provider = 'aws';` | Return all hosts that are in the prod environment and the AWS cloud provider. | +| `OR` | Filter records based on more than one condition. | `SELECT * FROM host WHERE env = 'prod' AND cloud_provider = 'aws';` | Return all hosts that are either in the prod environment or the aws cloud provider. | DDSQL also supports the following comparator keywords as they are defined in the SQL standard: -- `IS NULL` -- `IS NOT NULL` -- `LIKE` -- `NOT LIKE` -- `IN` -- `NOT IN` +| Operator | Description | Example | Result | +|--------------|------------------------|---------|--------| +| `IS NULL` | Select rows if the specified field is null. | `SELECT * FROM host WHERE cloud_provider IS NULL;` | Return all rows that contain no data in the `cloud_provider` column. | +| `IS NOT NULL`| Select rows if the specified field is not null. Exclude rows with missing data. | `SELECT * FROM host WHERE cloud_provider IS NOT NULL;` | Return all rows that contain data in the `cloud_provider` column. | +| `LIKE` | Search for a specific pattern in a string value. You can use the following wildcard characters to define the patterns:
**Percent sign (%)**: Represents zero, one, or multiple characters.
**Underscore (_)**: Represents a single character. | `SELECT * FROM aws_eks_cluster WHERE LOWER(logging) LIKE '%"enabled":true%';` | Return all rows from the `aws_eks_cluster` table where the `logging` column is `"enabled":true`. | +| `NOT LIKE` | Exclude rows from a search, where the row has a specific pattern in a string value. You can use the wildcards `%` and `_` for pattern matching. | `SELECT * FROM aws_eks_cluster WHERE LOWER(logging) NOT LIKE '%"enabled":true%';` | Return all rows from the `aws_eks_cluster` table where the `logging` does **not** have `"enabled":true%'`. | +| `IN` | Find multiple values in a `WHERE` clause. The `IN` operator is shorthand for multiple `OR` conditions. | `SELECT * FROM host WHERE cloud_provider IN ('aws', 'gcp');` | Return all rows from `host` table where the `cloud_provider` value is either 'aws' or 'gcp'.| +| `NOT IN` | Replace a set of arguments with the `<>` or `!=` operator that is combined with the `AND` operator| `SELECT * FROM host WHERE cloud_provider NOT IN ('aws', 'gcp');` | Return all rows where `cloud_provider` is not `aws` or `gcp`. | + DDSQL supports the `BETWEEN` keyword such that `a BETWEEN x AND y` is equivalent to `a >= x AND a <= y`. See [the Postgres documentation for `BETWEEN`][2] for details. diff --git a/content/en/developers/community/libraries.md b/content/en/developers/community/libraries.md index b273fbc4eadf3..7c56ff8a9b6a8 100644 --- a/content/en/developers/community/libraries.md +++ b/content/en/developers/community/libraries.md @@ -85,7 +85,7 @@ This is for a [FreeSwitch ESL][30] application to export statistics to Datadog u Heroku emits dyno metrics through logs. To convert these logs into metrics and send them to Datadog, use one of the following log drains. To send your Heroku logs to Datadog, see [Collect Heroku logs][34]. -* [Heroku Datadog Log Drain][35] written in Nodejs by [Oz][36]. +* [Heroku Datadog Log Drain][35] written in Node.js by [Oz][36]. * [Heroku Datadog Log Drain][37] written in Go by [Apiary][38]. To use the PHP tracer or profiler on Heroku, use the following buildpack. diff --git a/content/en/developers/dogstatsd/_index.md b/content/en/developers/dogstatsd/_index.md index 6927ca1c24bbc..e633cbb915abd 100644 --- a/content/en/developers/dogstatsd/_index.md +++ b/content/en/developers/dogstatsd/_index.md @@ -10,7 +10,7 @@ aliases: further_reading: - link: 'integrations/node' tag: 'Documentation' - text: 'Enable DogStatsD for NodeJS through the NodeJS integration' + text: 'Enable DogStatsD for Node.js through the Node.js integration' - link: 'developers/dogstatsd' tag: 'Documentation' text: 'Introduction to DogStatsD' diff --git a/content/en/integrations/guide/source-code-integration.md b/content/en/integrations/guide/source-code-integration.md index e9ac39ad4bbdb..127aa98df2d6f 100644 --- a/content/en/integrations/guide/source-code-integration.md +++ b/content/en/integrations/guide/source-code-integration.md @@ -219,9 +219,9 @@ If you are using a host, you have two options: using Microsoft SourceLink or con {{% sci-dd-git-env-variables %}} {{% /tab %}} -{{% tab "NodeJS" %}} +{{% tab "Node.js" %}} -
The NodeJS client library version 3.21.0 or later is required.
+
The Node.js client library version 3.21.0 or later is required.
#### Containers diff --git a/content/en/logs/log_configuration/attributes_naming_convention.md b/content/en/logs/log_configuration/attributes_naming_convention.md index 9d4e1b052f13e..7982d4a5253fa 100644 --- a/content/en/logs/log_configuration/attributes_naming_convention.md +++ b/content/en/logs/log_configuration/attributes_naming_convention.md @@ -79,7 +79,7 @@ See the full list of [Log Management Default Standard Attributes][9], which is s | [Network/communications][10] | These attributes are related to the data used in network communication. All fields and metrics are prefixed by `network`. | | [Geolocation][11] | These attributes are related to the geolocation of IP addresses used in network communication. All fields are prefixed by `network.client.geoip` or `network.destination.geoip`. | | [HTTP Requests][12] | These attributes are related to data commonly used in HTTP requests and accesses. All attributes are prefixed by `http`. Typical integrations relying on these attributes include [Apache][4], Rails, [AWS CloudFront][13], web applications servers, and so forth. URL details attributes are prefixed by `http.url_details`. These attributes provide details about the parsed parts of the HTTP URL. They are generated by the [URL parser][14]. | -| [Source code][15] | These attributes are related to data used when a log or an error is generated using a logger in a custom application. All attributes are prefixed either by `logger` or `error`. Typical integrations relying on these attributes are Java, NodeJs, .NET, Golang, Python, and so on. | +| [Source code][15] | These attributes are related to data used when a log or an error is generated using a logger in a custom application. All attributes are prefixed either by `logger` or `error`. Typical integrations relying on these attributes are Java, Node.js, .NET, Golang, Python, and so on. | | [Database][16] | Typical integrations relying on these attributes are [Cassandra][17], [MySQL][18], [RDS][19], [Elasticsearch][20], and so on. | | [Performance][21] | These attributes are related to performance metrics. Datadog recommends [remapping][22] any durations within your logs on this attribute since they are displayed and used as a default [measure][1] for [trace search][23]. | | [User related attributes][24] | All attributes and measures are prefixed by `usr`. | diff --git a/content/en/quality_gates/_index.md b/content/en/quality_gates/_index.md index 199348ac9fdb9..e7a8b1f574136 100644 --- a/content/en/quality_gates/_index.md +++ b/content/en/quality_gates/_index.md @@ -18,6 +18,9 @@ further_reading: - link: "/account_management/audit_trail/" tag: "Documentation" text: "Learn about Audit Trail" +- link: "https://www.datadoghq.com/blog/datadog-flaky-tests/" + tag: "Blog" + text: "Flaky tests: their hidden costs and how to address flaky behavior" --- {{< site-region region="gov" >}} @@ -145,4 +148,4 @@ For more information, see the [Audit Trail documentation][4]. [9]: /tests/ [10]: /continuous_integration/ [11]: /code_analysis/static_analysis -[12]: /code_analysis/software_composition_analysis \ No newline at end of file +[12]: /code_analysis/software_composition_analysis diff --git a/content/en/security/application_security/code_security/setup/compatibility/nodejs.md b/content/en/security/application_security/code_security/setup/compatibility/nodejs.md index ebde759a9e027..b28a50b162986 100644 --- a/content/en/security/application_security/code_security/setup/compatibility/nodejs.md +++ b/content/en/security/application_security/code_security/setup/compatibility/nodejs.md @@ -9,7 +9,7 @@ code_lang_weight: 50 The following application security capabilities are supported in the Node.js library, for the specified tracer version: -| Application Security capability | Minimum NodeJS tracer version | +| Application Security capability | Minimum Node.js tracer version | |----------------------------------------|----------------------------------------------------| | Threat Detection | 4.0.0 | | Threat Protection | 4.0.0 | diff --git a/content/en/security/application_security/serverless/_index.md b/content/en/security/application_security/serverless/_index.md index 7c90e74ed7efd..c1e92f103bd49 100644 --- a/content/en/security/application_security/serverless/_index.md +++ b/content/en/security/application_security/serverless/_index.md @@ -353,7 +353,7 @@ To get full instrumentation, ensure you are calling `datadog-init` as the first ### Get started {{< tabs >}} -{{% tab "NodeJS" %}} +{{% tab "Node.js" %}} Add the following instructions and arguments to your Dockerfile. ```dockerfile diff --git a/content/en/security/application_security/software_composition_analysis/setup/compatibility/nodejs.md b/content/en/security/application_security/software_composition_analysis/setup/compatibility/nodejs.md index ebde759a9e027..b28a50b162986 100644 --- a/content/en/security/application_security/software_composition_analysis/setup/compatibility/nodejs.md +++ b/content/en/security/application_security/software_composition_analysis/setup/compatibility/nodejs.md @@ -9,7 +9,7 @@ code_lang_weight: 50 The following application security capabilities are supported in the Node.js library, for the specified tracer version: -| Application Security capability | Minimum NodeJS tracer version | +| Application Security capability | Minimum Node.js tracer version | |----------------------------------------|----------------------------------------------------| | Threat Detection | 4.0.0 | | Threat Protection | 4.0.0 | diff --git a/content/en/security/application_security/threats/add-user-info.md b/content/en/security/application_security/threats/add-user-info.md index 6c73f86ba2e2e..00b20fad670ff 100644 --- a/content/en/security/application_security/threats/add-user-info.md +++ b/content/en/security/application_security/threats/add-user-info.md @@ -593,7 +593,7 @@ The following examples show how to track login events or custom events (using si {{< /programming-lang >}} {{< programming-lang lang="nodejs" >}} -Starting in dd-trace-js v3.13.1, you can use the NodeJS tracer's API to track user events. +Starting in dd-trace-js v3.13.1, you can use the Node.js tracer's API to track user events. The following examples show how to track login events or custom events (using signup as an example). diff --git a/content/en/security/application_security/threats/setup/compatibility/nodejs.md b/content/en/security/application_security/threats/setup/compatibility/nodejs.md index ebde759a9e027..b28a50b162986 100644 --- a/content/en/security/application_security/threats/setup/compatibility/nodejs.md +++ b/content/en/security/application_security/threats/setup/compatibility/nodejs.md @@ -9,7 +9,7 @@ code_lang_weight: 50 The following application security capabilities are supported in the Node.js library, for the specified tracer version: -| Application Security capability | Minimum NodeJS tracer version | +| Application Security capability | Minimum Node.js tracer version | |----------------------------------------|----------------------------------------------------| | Threat Detection | 4.0.0 | | Threat Protection | 4.0.0 | diff --git a/content/en/security/application_security/threats/setup/threat_detection/nodejs.md b/content/en/security/application_security/threats/setup/threat_detection/nodejs.md index d66e3854da601..58ce761e80057 100644 --- a/content/en/security/application_security/threats/setup/threat_detection/nodejs.md +++ b/content/en/security/application_security/threats/setup/threat_detection/nodejs.md @@ -1,5 +1,5 @@ --- -title: Enabling ASM for NodeJs +title: Enabling ASM for Node.js code_lang: nodejs type: multi-code-lang code_lang_weight: 50 @@ -29,7 +29,7 @@ You can monitor application security for Node.js apps running in Docker, Kuberne ## Enabling threat detection ### Get started -1. **Update your Datadog Node.js library package** to at least version 5.0.0 (for Node 18+) or 4.0.0 (for Node 16+) or 3.10.0 (for NodeJS 14+), by running one of these commands: +1. **Update your Datadog Node.js library package** to at least version 5.0.0 (for Node 18+) or 4.0.0 (for Node 16+) or 3.10.0 (for Node.js 14+), by running one of these commands: ```shell npm install dd-trace@^5 npm install dd-trace@^4 @@ -37,7 +37,7 @@ You can monitor application security for Node.js apps running in Docker, Kuberne ``` Use this [migration guide][1] to assess any breaking changes if you upgraded your library. - Application Security Management is compatible with Express v4+ and NodeJS v14+. For additional information, see [Compatibility][2]. + Application Security Management is compatible with Express v4+ and Node.js v14+. For additional information, see [Compatibility][2]. 2. **Where you import and initialize the Node.js library for APM, also enable ASM.** This might be either in your code or with environment variables. If you initialized APM in code, add `{appsec: true}` to your init statement: {{< tabs >}} diff --git a/content/en/security/application_security/troubleshooting.md b/content/en/security/application_security/troubleshooting.md index ab28f20aaa110..b2f7ea50390a5 100644 --- a/content/en/security/application_security/troubleshooting.md +++ b/content/en/security/application_security/troubleshooting.md @@ -551,7 +551,7 @@ See the Application Security product set up documentation to validate you you ar ### Ensure the communication of telemetry data -Ensure the `DD_INSTRUMENTATION_TELEMETRY_ENABLED` environment variable (`DD_TRACE_TELEMETRY_ENABLED` for NodeJS) is set to `true`, or the corresponding system property for your language is enabled. For example in Java: `-Ddd.instrumentation.telemetry.enabled=true` +Ensure the `DD_INSTRUMENTATION_TELEMETRY_ENABLED` environment variable (`DD_TRACE_TELEMETRY_ENABLED` for Node.js) is set to `true`, or the corresponding system property for your language is enabled. For example in Java: `-Ddd.instrumentation.telemetry.enabled=true` ## Disabling threat management and protection diff --git a/content/en/security/cloud_security_management/setup/supported_deployment_types.md b/content/en/security/cloud_security_management/setup/supported_deployment_types.md index 47a05bf09f6f8..7dc8136669c54 100644 --- a/content/en/security/cloud_security_management/setup/supported_deployment_types.md +++ b/content/en/security/cloud_security_management/setup/supported_deployment_types.md @@ -16,7 +16,7 @@ The following table summarizes the CSM features available relative to each deplo | Kubernetes | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | | | | Linux | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | | | | Amazon ECS/EKS | {{< X >}} | {{< X >}} | {{< X >}} | {{< X >}} | | | -| Windows | {{< X >}} | | {{< X >}} | beta | | | +| Windows | {{< X >}} | | {{< X >}} | {{< X >}} | | | | AWS Fargate ECS/EKS | {{< X >}} | | beta | | | | The following table summarizes the scope of coverage available relative to each CSM feature. @@ -28,7 +28,7 @@ The following table summarizes the scope of coverage available relative to each | Kubernetes Cluster | {{< X >}} | {{< X >}} | | | | | Docker Host | {{< X >}} | | | | | | Linux Host | {{< X >}} | {{< X >}} | {{< X >}} | | {{< X >}} | -| Windows Host | | {{< X >}} | beta | | | +| Windows Host | | {{< X >}} | {{< X >}} | | | | Docker Container | | {{< X >}} | | | | | Container Image | | | {{< X >}} | | {{< X >}} | | IAM in AWS Account | | | | {{< X >}} | | diff --git a/content/en/security/cloud_siem/historical_jobs.md b/content/en/security/cloud_siem/historical_jobs.md index 9a96818a6fc70..f85ed90a644d3 100644 --- a/content/en/security/cloud_siem/historical_jobs.md +++ b/content/en/security/cloud_siem/historical_jobs.md @@ -6,11 +6,7 @@ further_reading: text: "Backtest detection rules with Datadog Cloud SIEM Historical Jobs" --- -{{< callout url="https://forms.gle/mpE85RkdKnPG7cYeA" header="Join the Beta!">}} -Historical Jobs is in private beta. -{{< /callout >}} - -Historical Jobs allows you to backtest detections by running them against historical logs stored in Datadog Cloud SIEM. +Historical Jobs allows you to backtest detections by running them against historical logs stored in Datadog Cloud SIEM. Unlike a real-time rule, a Historical Job does not run continuously. Historical Jobs are one-time executable queries that analyze a specified period of historical data. diff --git a/content/en/serverless/guide/serverless_tracing_and_bundlers.md b/content/en/serverless/guide/serverless_tracing_and_bundlers.md index cf351ae777521..d439d2e6aae35 100644 --- a/content/en/serverless/guide/serverless_tracing_and_bundlers.md +++ b/content/en/serverless/guide/serverless_tracing_and_bundlers.md @@ -156,7 +156,7 @@ If you deploy Node.js Lambda functions using the `NodeJsFunction` construct, but return [] } }, - externalModules: ['@aws-sdk/client-dynamodb'] // The AWS SDK is included as part of the NodeJS Lambda runtime + externalModules: ['@aws-sdk/client-dynamodb'] // The AWS SDK is included as part of the Node.js Lambda runtime } }); ``` diff --git a/content/en/tracing/guide/agent-5-tracing-setup.md b/content/en/tracing/guide/agent-5-tracing-setup.md index 35f93dc403665..3a40920bda9d1 100644 --- a/content/en/tracing/guide/agent-5-tracing-setup.md +++ b/content/en/tracing/guide/agent-5-tracing-setup.md @@ -40,7 +40,7 @@ For additional information, reference [the Docker page][7]. {{< nextlink href="tracing/setup/python" tag="Python" >}}Python language instrumentation.{{< /nextlink >}} {{< nextlink href="tracing/setup/ruby" tag="Ruby" >}}Ruby language instrumentation{{< /nextlink >}} {{< nextlink href="tracing/setup/go" tag="Go" >}}Go language instrumentation.{{< /nextlink >}} - {{< nextlink href="tracing/setup/nodejs" tag="Nodejs" >}}Node.js language instrumentation.{{< /nextlink >}} + {{< nextlink href="tracing/setup/nodejs" tag="Node.js" >}}Node.js language instrumentation.{{< /nextlink >}} {{< nextlink href="tracing/setup/dotnet" tag=".NET" >}}.NET language instrumentation.{{< /nextlink >}} {{< nextlink href="tracing/setup/php" tag="PHP" >}}PHP language instrumentation.{{< /nextlink >}} {{< /whatsnext >}} diff --git a/content/en/tracing/guide/inferred-service-opt-in.md b/content/en/tracing/guide/inferred-service-opt-in.md index 7c0f1c8359c38..9654db2050680 100644 --- a/content/en/tracing/guide/inferred-service-opt-in.md +++ b/content/en/tracing/guide/inferred-service-opt-in.md @@ -27,7 +27,7 @@ With the new inferred entities experience, you can filter [Service Catalog][3] e To determine the names and types of the inferred service dependencies, Datadog uses standard span attributes and maps them to `peer.*` attributes. For the full list of `peer.*` attributes, see [Inferred service dependencies nomenclature](#inferred-service-dependencies-nomemclature). Inferred external APIs use the default naming scheme `net.peer.name`. For example, `api.stripe.com`, `api.twilio.com`, `us6.api.mailchimp.com`. Inferred databases use the default naming scheme `db.instance`. -If you're using the Go, Java, NodeJS, PHP, .NET, or Ruby tracer, you can customize the default names for inferred entities. +If you're using the Go, Java, Node.js, PHP, .NET, or Ruby tracer, you can customize the default names for inferred entities. **Note:** If you configure monitors, dashboards, or notebooks for a given inferred service during the beta, you may need to update them if the naming scheme changes. Read more about migration steps in the [opt-in instructions](#opt-in). @@ -171,9 +171,9 @@ To opt in, add the following environment variables or system properties to your {{% /tab %}} -{{% tab "NodeJS" %}} +{{% tab "Node.js" %}} -The minimum NodeJS tracer versions required are [2.44.0][1], [3.31.0][2], or [4.10.0][3]. Regular updates to the latest version are recommended to access changes and bug fixes. +The minimum Node.js tracer versions required are [2.44.0][1], [3.31.0][2], or [4.10.0][3]. Regular updates to the latest version are recommended to access changes and bug fixes. To opt in, add the following environment variables or system properties to your tracer settings: diff --git a/content/en/tracing/trace_collection/custom_instrumentation/opentracing/_index.md b/content/en/tracing/trace_collection/custom_instrumentation/opentracing/_index.md index 9b44ca8370232..bee84b5a3aee7 100644 --- a/content/en/tracing/trace_collection/custom_instrumentation/opentracing/_index.md +++ b/content/en/tracing/trace_collection/custom_instrumentation/opentracing/_index.md @@ -17,7 +17,7 @@ Read more for your language: {{< nextlink href="/tracing/trace_collection/custom_instrumentation/opentracing/python" >}}Python{{< /nextlink >}} {{< nextlink href="/tracing/trace_collection/custom_instrumentation/opentracing/ruby" >}}Ruby{{< /nextlink >}} {{< nextlink href="/tracing/trace_collection/custom_instrumentation/opentracing/go" >}}Go{{< /nextlink >}} - {{< nextlink href="/tracing/trace_collection/custom_instrumentation/opentracing/nodejs" >}}NodeJS{{< /nextlink >}} + {{< nextlink href="/tracing/trace_collection/custom_instrumentation/opentracing/nodejs" >}}Node.js{{< /nextlink >}} {{< nextlink href="/tracing/trace_collection/custom_instrumentation/opentracing/php" >}}PHP{{< /nextlink >}} {{< nextlink href="/tracing/trace_collection/custom_instrumentation/opentracing/dotnet" >}}.NET{{< /nextlink >}} {{< /whatsnext >}} diff --git a/content/en/tracing/trace_collection/library_injection_local.md b/content/en/tracing/trace_collection/library_injection_local.md index 9c0d92690f349..1f021a5be2e16 100644 --- a/content/en/tracing/trace_collection/library_injection_local.md +++ b/content/en/tracing/trace_collection/library_injection_local.md @@ -30,7 +30,7 @@ To learn more about Kubernetes Admission Controller, read [Kubernetes Admission ## Requirements * Kubernetes v1.14+ -* Datadog [Cluster Agent v7.40+][3] for Java, Python, NodeJS, Datadog [Cluster Agent v7.44+][3] for .NET and Ruby. +* Datadog [Cluster Agent v7.40+][3] for Java, Python, Node.js, Datadog [Cluster Agent v7.44+][3] for .NET and Ruby. * Datadog Admission Controller enabled. **Note**: In Helm chart v2.35.0 and later, Datadog Admission Controller is activated by default in the Cluster Agent. * For Python, uWSGI applications are not supported at this time. * For Ruby, library injection support is in Beta. Instrumentation is only supported for Ruby on Rails applications with Bundler version greater than 2.3 and without vendored gems (deployment mode or `BUNDLE_PATH`). diff --git a/content/en/tracing/trace_collection/trace_context_propagation/_index.md b/content/en/tracing/trace_collection/trace_context_propagation/_index.md index 37258defb98e5..4438f1fb2b323 100644 --- a/content/en/tracing/trace_collection/trace_context_propagation/_index.md +++ b/content/en/tracing/trace_collection/trace_context_propagation/_index.md @@ -193,11 +193,11 @@ The Datadog Go SDK supports the following trace context formats, including depre {{% /tab %}} -{{% tab "NodeJS" %}} +{{% tab "Node.js" %}} ### Supported formats -The Datadog NodeJS SDK supports the following trace context formats, including deprecated configuration values: +The Datadog Node.js SDK supports the following trace context formats, including deprecated configuration values: | Format | Configuration Value | |------------------------|---------------------| diff --git a/content/en/universal_service_monitoring/setup.md b/content/en/universal_service_monitoring/setup.md index a26636b0c5960..f60a71be5488b 100644 --- a/content/en/universal_service_monitoring/setup.md +++ b/content/en/universal_service_monitoring/setup.md @@ -825,10 +825,10 @@ agents: {{< /tabs >}} {{< /collapse-content >}} -{{< collapse-content title="NodeJS TLS Monitoring" level="h4" >}} +{{< collapse-content title="Node.js TLS Monitoring" level="h4" >}}
-Universal Service Monitoring is available in beta to monitor HTTP, HTTP/2, and gRPC requests from services implemented in NodeJS. +Universal Service Monitoring is available in beta to monitor HTTP, HTTP/2, and gRPC requests from services implemented in Node.js.
Requires Agent version 7.54 or greater. diff --git a/content/es/database_monitoring/setup_mysql/troubleshooting.md b/content/es/database_monitoring/setup_mysql/troubleshooting.md index 07972c194a6f8..49a2ddff26075 100644 --- a/content/es/database_monitoring/setup_mysql/troubleshooting.md +++ b/content/es/database_monitoring/setup_mysql/troubleshooting.md @@ -212,10 +212,42 @@ GRANT EXECUTE ON PROCEDURE datadog.enable_events_statements_consumers TO datadog ### Falta el esquema o la base de datos en métricas de consulta y muestras de MySQL -La etiqueta `schema` (también conocida como "base de datos") está presente en métricas de consulta y muestras de MySQL solo cuando se configura una base de datos predeterminada en la conexión que realizó la consulta. La base de datos predeterminada es configurada por la aplicación especificando el "esquema" en los parámetros de conexión a la base de datos, o ejecutando la [sentencia USE][9] en una conexión ya existente. +La etiqueta (tag) `schema` (también conocida como "base de datos") está presente en métricas de consulta y muestras de MySQL solo cuando se configura una base de datos predeterminada en la conexión que realizó la consulta. La base de datos predeterminada es configurada por la aplicación especificando el "esquema" en los parámetros de conexión a la base de datos, o ejecutando la [sentencia USE][9] en una conexión ya existente. Si no hay ninguna base de datos por defecto configurada para una conexión, ninguna de las consultas realizadas por esa conexión tendrá la etiqueta `schema` en ellas. +## Limitaciones conocidas de MariaDB + +### Métricas de InnoDB incompatibles + +Los siguientes métricas de InnoDB no están disponibles para ciertas versiones de MariaDB: + +| Nombre de la métrica | Versiones de MariaDB | +| --------------------------------------- | ----------------------- | +| `mysql.innodb.hash_index_cells_total` | 10.5, 10.6, 10.11, 11.1 | +| `mysql.innodb.hash_index_cells_used` | 10.5, 10.6, 10.11, 11.1 | +| `mysql.innodb.os_log_fsyncs` | 10.11, 11.1 | +| `mysql.innodb.os_log_pending_fsyncs` | 10.11, 11.1 | +| `mysql.innodb.os_log_pending_writes` | 10.11, 11.1 | +| `mysql.innodb.pending_log_flushes` | 10.11, 11.1 | +| `mysql.innodb.pending_log_writes` | 10.5, 10.6, 10.11, 11.1 | +| `mysql.innodb.pending_normal_aio_reads` | 10.5, 10.6, 10.11, 11.1 | +| `mysql.innodb.pending_normal_aio_writes`| 10.5, 10.6, 10.11, 11.1 | +| `mysql.innodb.rows_deleted` | 10.11, 11.1 | +| `mysql.innodb.rows_inserted` | 10.11, 11.1 | +| `mysql.innodb.rows_updated` | 10.11, 11.1 | +| `mysql.innodb.rows_read` | 10.11, 11.1 | +| `mysql.innodb.s_lock_os_waits` | 10.6, 10.11, 11.1 | +| `mysql.innodb.s_lock_spin_rounds` | 10.6, 10.11, 11.1 | +| `mysql.innodb.s_lock_spin_waits` | 10.6, 10.11, 11.1 | +| `mysql.innodb.x_lock_os_waits` | 10.6, 10.11, 11.1 | +| `mysql.innodb.x_lock_spin_rounds` | 10.6, 10.11, 11.1 | +| `mysql.innodb.x_lock_spin_waits` | 10.6, 10.11, 11.1 | + +### Plan de explicación de MariaDB + +MariaDB no produce el mismo formato JSON que MySQL para los planes de explicación. Ciertos campos del plan de explicación pueden faltar en los planes de explicación de MariaDB, incluyendo `cost_info`, `rows_examined_per_scan`, `rows_produced_per_join` y `used_columns`. + [1]: /es/database_monitoring/setup_mysql/ [2]: /es/agent/troubleshooting/ [3]: /es/agent/configuration/agent-commands/?tab=agentv6v7#agent-status-and-information diff --git a/content/es/developers/dogstatsd/_index.md b/content/es/developers/dogstatsd/_index.md index 6663be81c2804..edd0d13269841 100644 --- a/content/es/developers/dogstatsd/_index.md +++ b/content/es/developers/dogstatsd/_index.md @@ -10,7 +10,7 @@ description: Descripción general de las características de DogStatsD, incluido further_reading: - link: integrations/node tag: Documentación - text: Habilitar DogStatsD para NodeJS a través de la integración de NodeJS + text: Habilitar DogStatsD para Node.js a través de la integración de Node.js - link: developers/dogstatsd tag: Documentación text: Introducción a DogStatsD diff --git a/content/es/integrations/guide/source-code-integration.md b/content/es/integrations/guide/source-code-integration.md index d0d98125d22f7..874d72ff06b28 100644 --- a/content/es/integrations/guide/source-code-integration.md +++ b/content/es/integrations/guide/source-code-integration.md @@ -222,9 +222,9 @@ Si utilizas un host, tienes dos opciones: utilizar Microsoft SourceLink o config {{% sci-dd-git-env-variables %}} {{% /tab %}} -{{% tab "NodeJS" %}} +{{% tab "Node.js" %}} -
Se requiere la biblioteca del cliente NodeJS versión 3.21.0 o posterior.
+
Se requiere la biblioteca del cliente Node.js versión 3.21.0 o posterior.
#### Contenedores diff --git a/content/es/integrations/mainstorconcept_ziris.md b/content/es/integrations/mainstorconcept_ziris.md index 722f4e937de3b..892dc876e14f4 100644 --- a/content/es/integrations/mainstorconcept_ziris.md +++ b/content/es/integrations/mainstorconcept_ziris.md @@ -233,7 +233,7 @@ A continuación se muestra un lista completo de todas las etiquetas (tags) cread | zos.cics.connection.type | Tipo de conexión CICS | | zos.cics.ipconn_name | Nombre conexión IP de CICS | | zos.cics.net.peer.name | Nombre del par de red CICS | -| zos.cics.nodejs_application_name | Nombre de la aplicación CICS NodeJS | +| zos.cics.nodejs_application_name | Nombre de la aplicación CICS Node.js | | zos.cics.pipeline_name | Nombre del canal CICS | | zos.cics.region_name | Nombre de la región CICS | | zos.cics.session.id | ID de sesión CICS | diff --git a/content/es/integrations/prometheus.md b/content/es/integrations/prometheus.md index ac7c38873e76a..de65f3a8ef00e 100644 --- a/content/es/integrations/prometheus.md +++ b/content/es/integrations/prometheus.md @@ -3,7 +3,7 @@ app_id: prometheus app_uuid: b978d452-7008-49d0-bb87-62d8639b2205 assets: integration: - auto_install: true + auto_install: verdadero configuration: spec: assets/configuration/spec.yaml events: @@ -23,13 +23,13 @@ categories: custom_kind: integración dependencies: - https://github.com/DataDog/integrations-core/blob/master/prometheus/README.md -display_on_public_website: true +display_on_public_website: verdadero draft: false git_integration_title: prometheus integration_id: prometheus integration_title: Prometheus (heredado) integration_version: 5.0.0 -is_public: true +is_public: verdadero manifest_version: 2.0.0 name: prometheus public_title: Prometheus (heredado) @@ -83,7 +83,7 @@ Todas las métricas recuperadas por esta integración se consideran Haz clic aquí para adquirir esta aplicación. \ No newline at end of file diff --git a/content/es/integrations/tyk.md b/content/es/integrations/tyk.md new file mode 100644 index 0000000000000..abc8d08ccae03 --- /dev/null +++ b/content/es/integrations/tyk.md @@ -0,0 +1,224 @@ +--- +app_id: tyk +app_uuid: caca4c4f-104b-4d28-a051-f09bc58a0a32 +assets: + dashboards: + Tyk Analytics Canvas: assets/dashboards/tyk_analytics_canvas.json + integration: + auto_install: true + configuration: {} + events: + creates_events: false + metrics: + check: + - tyk.request_time.95percentile + - tyk.request_time.count + - tyk.request_time.avg + - tyk.request_time.max + - tyk.request_time.median + metadata_path: metadata.csv + prefix: tyk. + service_checks: + metadata_path: assets/service_checks.json + source_type_id: 10233 + source_type_name: Tyk +author: + homepage: https://github.com/DataDog/integrations-extras + name: Tyk + sales_email: yaara@tyk.io + support_email: yaara@tyk.io +categories: +- métricas +custom_kind: integración +dependencies: +- https://github.com/DataDog/integrations-extras/blob/master/tyk/README.md +display_on_public_website: true +draft: false +git_integration_title: tyk +integration_id: tyk +integration_title: Tyk +integration_version: '' +is_public: true +manifest_version: 2.0.0 +name: tyk +public_title: Tyk +short_description: Realiza un seguimiento de solicitudes con estadísticas de tiempo + segmentadas por resp-code, api, path, oauth, etc. +supported_os: +- Linux +- Windows +- macOS +tile: + changelog: CHANGELOG.md + classifier_tags: + - Sistema operativo compatible::Linux + - Sistema operativo compatible::Windows + - Categoría::Métricas + - Sistema operativo compatible::macOS + - Oferta::Integración + configuration: README.md#Configuración + description: Realiza un seguimiento de solicitudes con estadísticas de tiempo segmentadas + por resp-code, api, path, oauth, etc. + media: [] + overview: README.md#Información general + support: README.md#Soporte + title: Tyk +--- + + + + +## Información general + +Datadog puede recopilar y mostrar errores, tiempo de respuesta, duración, latencia, así como monitorizar el rendimiento del tráfico de API en [Tyk][1] para descubrir problemas en tus API o consumidores. + +Tyk tiene una integración Datadog incorporada que recopila métricas de la [pasarela API de Tyk][2]. + +La pasarela API de Tyk registra todo el tráfico que procesa. Luego, envía esa información a Datadog y crea dashboards en torno a ella. + +### Cómo funciona + +La [bomba Tyk][3] escribe métricas de aplicaciones personalizadas y las envía a Datadog enviándolas a [DogStatsD][4], un servicio de agregación de métricas incluido en el Datadog Agent. DogStatsD implementa el protocolo StatsD, que añade algunas extensiones específicas de Datadog, incluido el tipo de métrica Histogram, utilizado por `Tyk-gateway`. + +`Tyk-gateway` utiliza `Tyk-pump` para enviar los análisis que ha generado a Datadog. + +Cuando se ejecuta el Datadog Agent, DogStatsD obtiene una métrica `request_time` de `Tyk-pump` en tiempo real, por solicitud, para que puedas comprender el uso de tus API y obtener la flexibilidad de agregar según varios parámetros como fecha, versión, código devuelto, método, etc. + +La métrica personalizada que Tyk está utilizando es de tipo [DD_HISTOGRAM_AGGREGATES][5]. + +## Configuración + +La integración Tyk está incluida en el paquete `tyk-pump`, por lo que sólo tienes que realizar la configuración en `pump.conf` (y no es necesario instalar nada en tu plataforma Tyk). + +### Instalación + +#### Instalación + +Para esta integración necesitas tener una instalación Tyk en ejecución. Puedes instalar [Tyk autogestionado][6] o [Tyk OSS][7]. Ambas opciones incluyen `tyk-pump`. + +#### Instalación del Datadog Agent + +Instala el [Datadog Agent][8] en tu entorno. + +Ejecuta el Datadog [Agent][9] en tu clúster K8s, como un contenedor Docker, en tu Mac o de cualquier forma, siempre que `Tyk pump` pueda acceder a él. + +Para entornos contenedorizados, consulta las [plantillas de la integración Autodiscovery][10] para obtener más información. Para verificar que los cambios se han aplicado, [ejecuta los subcomandos de estado del Agent][11]. + + +### Configuración + +#### Bomba-Tyk +Para configurar una bomba Datadog, sigue las instrucciones de la [sección DogStatsD][12] del LÉEME de la bomba. + +El siguiente es un ejemplo de configuración de una bomba de Datadog en `pump.conf`: + +``` json +pump.conf: +... + "dogstatsd": { + "type": "dogstatsd", + "meta": { + "address": "dd-agent:8126", + "namespace": "tyk", + "async_uds": true, + "async_uds_write_timeout_seconds": 2, + "buffered": true, + "buffered_max_messages": 32, + "sample_rate": 0.9999999999, + "tags": [ + "method", + "response_code", + "api_version", + "api_name", + "api_id", + "org_id", + "tracked", + "path", + "oauth_id" + ] + } + }, +``` + +Este [ejemplo][13] se ha tomado del proyecto [Tyk-demo][14], un proyecto de código abierto que pone en marcha una plataforma Tyk completa con un solo comando y ofrece ejemplos listos para utilizar, incluido el ejemplo de Datadog. Para ejecutar esta integración, utiliza `up.sh analytics-datadog`. + +#### Configuración del Datadog Agent + +La integración Tyk utiliza [DogStatsD][15]. Se trata de un servicio de agregación de métricas incluido con el Datadog Agent. DogStatsD implementa el protocolo `StatsD` y añade algunas extensiones específicas de Datadog. Tyk utiliza `Histogram metric type`. + +Configura las siguientes variables de entorno de Datadog y DogStatsD en tu entorno: + +| Variable de entorno DD | Valor | Descripción | +|---------------------------|-------------|------| +| DD_API_KEY | {tu_clave_de_api_datadog} | Para que el Datadog Agent se conecte con el portal DD. Tu clave API se encuentra en [Configuración de la cuenta][16]. | +| DD_ENV | tyk-demo-env | Define el nombre del entorno. | +| DD_DOGSTATSD_TAGS | "env:tyk-demo" | Etiquetas (tags) adicionales para añadir a todas las métricas, eventos y checks de servicio recibidos por este servidor DogStatsD. | +| DD_LOGS_ENABLED | true | Habilita la recopilación de logs para el Datadog Agent. | +| DD_LOGS_CONFIG_CONTAINER_COLLECT_ALL | true | Recopila logs de los contenedores. | +| DD_DOGSTATSD_SOCKET | /var/run/docker.sock | Ruta al socket Unix a escuchar. Docker Compose crea esta ruta. | +| DD_DOGSTATSD_ORIGIN_DETECTION | true | Activa la detección de contenedores y el etiquetado para métricas de socket Unix. | +| DD_DOGSTATSD_NON_LOCAL_TRAFFIC | true | Escucha los paquetes DogStatsD de otros contenedores. (Necesario para enviar métricas personalizadas). | +| DD_AGENT_HOST | dd-Agent | Nombre del host del Agent en Docker. | +| DD_AC_EXCLUDE | redis | Excluye checks de Redis en Datadog. (opcional) | +| DD_CONTAINER_EXCLUDE | true | Excluye checks de Docker del Datadog Agent. | + +Después de configurar las variables de entorno enumeradas anteriormente, configura el Agent [con DogStatsD][17]. + +[Reinicia el Agent][18] después de la configuración. + +### Validación + +Crea un dashboard o importa [la muestra][19] y añade un widget. En la sección **Graph your data** (Haz gráficos de tus datos), en la opción **métrica**, empieza a escribir el espacio de nombres que elegiste para la bomba en la configuración `pump.conf` en`dogstatsd.namespace`. + +En el ejemplo anterior, es `tyk`. Una vez que empieces a escribir, se mostrarán todas las métricas disponibles. + +## Datos recopilados + +### Métricas +{{< get-metrics-from-git "tyk" >}} + + +### Dashboards + +Con Datadog, puedes crear dashboards que muestren estadísticas sobre tus servicios API y su consumo. + +El siguiente es un ejemplo de este tipo de dashboard: + +![Tyk Analytics dashboard example][21] + +**Nota: Puedes [importar][19] el dashboard anterior y utilizarlo como ejemplo o referencia para tu propio dashboard.** + +### Eventos + +La integración Tyk no incluye eventos. + +### Checks de servicio + +La integración Tyk no incluye checks de servicio. + +## Solucionar problemas + +¿Necesitas ayuda? Ponte en contacto con el [servicio de asistencia de Datadog][22]. + +[1]: https://tyk.io/ +[2]: https://github.com/TykTechnologies/tyk +[3]: https://tyk.io/docs/tyk-pump/ +[4]: https://docs.datadoghq.com/es/developers/dogstatsd/?tab=hostagent#pagetitle +[5]: https://docs.datadoghq.com/es/agent/docker/?tab=standard#dogstatsd-custom-metrics +[6]: https://tyk.io/docs/tyk-self-managed/install/ +[7]: https://tyk.io/docs/apim/open-source/installation/ +[8]: https://app.datadoghq.com/account/settings/agent/latest +[9]: https://docs.datadoghq.com/es/agent/ +[10]: https://docs.datadoghq.com/es/agent/kubernetes/integrations/ +[11]: https://docs.datadoghq.com/es/agent/guide/agent-commands/?tab=agentv6v7#agent-status-and-information +[12]: https://github.com/TykTechnologies/tyk-pump#dogstatsd +[13]: https://github.com/TykTechnologies/tyk-demo/blob/master/deployments/analytics-datadog/volumes/tyk-pump/pump-datadog.conf +[14]: https://github.com/TykTechnologies/tyk-demo/tree/master/deployments/analytics-datadog +[15]: https://docs.datadoghq.com/es/developers/dogstatsd/?tab=hostagent#setup +[16]: https://app.datadoghq.com/organization-settings/api-keys +[17]: https://docs.datadoghq.com/es/developers/dogstatsd/?tab=hostagent#how-it-works +[18]: https://docs.datadoghq.com/es/agent/guide/agent-commands/#start-stop-and-restart-the-agent +[19]: https://github.com/DataDog/integrations-extras/blob/master/tyk/assets/dashboards/tyk_analytics_canvas.json +[20]: https://github.com/DataDog/integrations-extras/blob/master/tyk/metadata.csv +[21]: https://raw.githubusercontent.com/DataDog/integrations-extras/master/tyk/images/datadog-tyk-analytics-dashboard.jpg +[22]: https://docs.datadoghq.com/es/help/ \ No newline at end of file diff --git a/content/es/logs/log_configuration/attributes_naming_convention.md b/content/es/logs/log_configuration/attributes_naming_convention.md index b57d0be408adb..59398b69d68c9 100644 --- a/content/es/logs/log_configuration/attributes_naming_convention.md +++ b/content/es/logs/log_configuration/attributes_naming_convention.md @@ -96,7 +96,7 @@ Consulta la lista completa lista de [atributos estándar por defecto de Log Mana - Los atributos de detalles de URL llevan el prefijo `http.url_details`. Estos atributos proporcionan información sobre las partes analizadas de la URL HTTP. Son generados por el [Analizador URL][14]. - [Código fuente][15] - Estos atributos están relacionados con los datos que se utilizan cuando se genera un log o un error utilizando un creador de logs en una aplicación personalizada. Todos los atributos llevan el prefijo `logger` o `error`. - - Las integraciones típicas que se basan en estos atributos son Java, NodeJS, .NET, Golang, Python, etc. + - Las integraciones típicas que se basan en estos atributos son Java, Node.js, .NET, Golang, Python, etc. - [Base de datos] [16] - Las integraciones típicas que se basan en estos atributos son [Cassandra][17], [MySQL][18], [RDS][19], [Elasticsearch][20], etc. - [Rendimiento][21] diff --git a/content/es/metrics/custom_metrics/dogstatsd_metrics_submission.md b/content/es/metrics/custom_metrics/dogstatsd_metrics_submission.md index 86d34c6e2a146..8b5c98874c535 100644 --- a/content/es/metrics/custom_metrics/dogstatsd_metrics_submission.md +++ b/content/es/metrics/custom_metrics/dogstatsd_metrics_submission.md @@ -202,7 +202,7 @@ while (TRUE) { ``` {{< /programming-lang >}} -{{< programming-lang lang="NodeJS" >}} +{{< programming-lang lang="Node.js" >}} ```javascript const tracer = require('dd-trace'); tracer.init(); @@ -379,7 +379,7 @@ while (TRUE) { ``` {{< /programming-lang >}} -{{< programming-lang lang="NodeJS" >}} +{{< programming-lang lang="Node.js" >}} ```javascript const tracer = require('dd-trace'); tracer.init(); @@ -982,7 +982,7 @@ while (TRUE) { ``` {{< /programming-lang >}} -{{< programming-lang lang="NodeJS" >}} +{{< programming-lang lang="Node.js" >}} ```javascript const tracer = require('dd-trace'); tracer.init(); @@ -1115,7 +1115,7 @@ $statsd->increment('example_metric.increment', array('environment' => 'dev', 'ac ``` {{< /programming-lang >}} -{{< programming-lang lang="NodeJS" >}} +{{< programming-lang lang="Node.js" >}} ```javascript tracer.dogstatsd.increment('example_metric.increment', 1, { environment: 'dev', account: 'local' }); ``` diff --git a/content/es/metrics/types.md b/content/es/metrics/types.md new file mode 100644 index 0000000000000..cf79f448eed5f --- /dev/null +++ b/content/es/metrics/types.md @@ -0,0 +1,357 @@ +--- +algolia: + tags: + - Tipos de métricas +aliases: +- /es/developers/metrics/counts/ +- /es/developers/metrics/distributions/ +- /es/developers/metrics/gauges/ +- /es/developers/metrics/histograms/ +- /es/developers/metrics/rates/ +- /es/developers/metrics/sets/ +- /es/developers/metrics_type/ +- /es/developers/metrics/metrics_type/ +- /es/developers/metrics/types/ +further_reading: +- link: developers/dogstatsd + tag: Documentación + text: Más información sobre DogStatsD +- link: desarrolladores/bibliotecas + tag: Documentación + text: API oficial y creada por la comunidad y bibliotecas cliente de DogStatsD +title: Tipos de métricas +--- + +## Información general + +Cada métrica enviada a Datadog debe tener un tipo. El tipo de métrica afecta a la forma en que se muestran los valores de la métrica cuando se consulta, así como a las posibilidades asociadas de creación de gráficas dentro de Datadog utilizando [modificadores][1] y [funciones][2] adicionales. El tipo de métrica se muestra en el panel lateral de detalles de la métrica en la [página Resumen de métricas][3]. + +**Nota**: Al cambiar el tipo de métrica en este panel lateral de detalles se puede cambiar el comportamiento de la métrica en todas las visualizaciones y monitores existentes, lo que puede llevar a que los datos históricos no tengan sentido. + +Se aceptan los siguientes tipos de envíos de métricas: + +- [COUNT](?tab=count#metric-types) +- [RATE](?tab=rate#metric-types) +- [GAUGE](?tab=gauge#metric-types) +- [SET][4] +- [HISTOGRAM](?tab=histogram#metric-types) +- [DISTRIBUTION](?tab=distribution#metric-types) + +Estos diferentes tipos de envíos de métricas se asignan a cuatro tipos de métricas dentro de la aplicación, que se encuentran en la aplicación web Datadog: + +- COUNT +- RATE +- GAUGE +- DISTRIBUTION + +**Nota**: Si envías una métrica a Datadog sin un tipo, el tipo de la métrica aparece como `Not Assigned` en Datadog. El tipo de métrica `Not Assigned` no se puede cambiar a otro tipo dentro de la aplicación hasta que se envíe un tipo inicial de métrica. + +## Envío comparado con tipo dentro de la aplicación + +Las métricas se envían a Datadog de tres formas principales: + +- [Check del Agent][5] +- [DogStatsD][6] +- [API HTTP Datadog][7] + +La mayoría de los datos que recibe Datadog son enviados por el Agent, ya sea a través de un check del Agent o DogStatsD. Para estos métodos de envío, el tipo de métrica determina cómo se agregan los múltiples valores recopilados en un Agent en [un intervalo de tiempo de descarga][8]. El Agent combina estos valores en un único valor de métrica representativo para ese intervalo. Este valor combinado se almacena con una única marca de tiempo en Datadog. + +Los datos enviados directamente a la API Datadog no son agregados por Datadog, a excepción de las métricas de distribución. Los valores brutos enviados a Datadog se almacenan tal cual. + +Para saber cómo se asignan los distintos tipos de envíos de métricas a sus correspondientes tipos dentro de la aplicación, consulta la sección [Tipos de envío y tipos dentro de la aplicación de Datadog](#submission-types-and-datadog-in-app-types). + +## Tipos de métricas + +### Definición + +{{< tabs >}} +{{% tab "COUNT" %}} + +El tipo de envío de métricas COUNT representa el número total de ocurrencias de eventos en un intervalo de tiempo. Un COUNT puede utilizarse para realizar un seguimiento del número total de conexiones realizadas a una base de datos o del número total de solicitudes a un endpoint. Este número de eventos puede acumularse o disminuir con el tiempo y no se incrementa monotónicamente. + +**Nota**: Un COUNT es diferente del tipo de métrica RATE, que representa el número de ocurrencias de eventos normalizadas por segundo dado el intervalo de tiempo definido. + +{{% /tab %}} +{{% tab "RATE" %}} + +El tipo de envío de métricas RATE representa el número total de ocurrencias de eventos por segundo en un intervalo de tiempo. Un RATE se puede utilizar para realizar un seguimiento de la frecuencia con la que ocurre algo, como la frecuencia de las conexiones realizadas a una base de datos o el flujo de solicitudes realizadas a un endpoint. + +**Nota**: Un RATE es diferente del tipo de envío de métricas COUNT, que representa el número total de ocurrencias de eventos en el intervalo de tiempo dado. + +{{% /tab %}} +{{% tab "GAUGE" %}} + +El tipo de envío de métricas GAUGE representa un snapshot de eventos en un intervalo de tiempo. Este valor representativo de snapshot es el último valor enviado al Agent durante un intervalo de tiempo. Un GAUGE se puede utilizar para tomar una medida de algo que informa continuamente, como el espacio disponible en disco o la memoria utilizada. + +{{% /tab %}} +{{% tab "HISTOGRAM" %}} + +El tipo de envío de métricas HISTOGRAM representa la distribución estadística de un conjunto de valores calculados del lado del Agent en un intervalo de tiempo. El tipo de métrica HISTOGRAM es una extensión del tipo de métrica de temporización StatsD. El Agent agrega los valores que se envían en un intervalo de tiempo definido y produce diferentes métricas que representan el conjunto de valores. + +Si envías valores `X` para una métrica HISTOGRAM `` en un intervalo de tiempo dado, las siguientes métricas son producidas por el Agent por defecto: + +`.avg` +: Representa la media de los valores `X` en un intervalo de tiempo.
+**Tipo dentro de la aplicación de Datadog**: GAUGE + +`.count` +: Representa el número de valores enviados durante el intervalo, `X`. El Agent envía este número como un RATE por lo que mostraría en el valor `X/interval` en la aplicación.
+**Tipo dentro de la aplicación de Datadog**: RATE + +`.median` +: Representa la mediana de los valores `X` en un intervalo de tiempo.
+**Tipo dentro de la aplicación de Datadog**: GAUGE + +`.95percentile` +: Representa el percentil 95 de esos valores `X` en un intervalo de tiempo.
+**Tipo dentro de la aplicación de Datadog**: GAUGE + +`.max` +: Representa el valor máximo de los valores de `X` enviados durante el intervalo de tiempo.
+**Tipo dentro de la aplicación de Datadog**: GAUGE + +**Nota**: + +- Configura qué agregaciones quieres enviar a Datadog con el parámetro `histogram_aggregates` en tu [archivo de configuración `datadog.yaml`][1]. Por defecto, sólo se envían a Datadog las agregaciones `max`, `median`, `avg` y `count`. También están disponibles las agregaciones `sum` y `min`. +- Configura qué agregación de percentiles quieres enviar a Datadog con el parámetro `histogram_percentiles` en tu [archivo de configuración `datadog.yaml`][2]. Por defecto, sólo se envía el `95percentile` a Datadog. + + +[1]: https://github.com/DataDog/datadog-agent/blob/04d8ae9dd4bc6c7a64a8777e8a38127455ae3886/pkg/config/config_template.yaml#L106-L114 +[2]: https://github.com/DataDog/datadog-agent/blob/04d8ae9dd4bc6c7a64a8777e8a38127455ae3886/pkg/config/config_template.yaml#L116-L121 +{{% /tab %}} +{{% tab "DISTRIBUTION" %}} + +El tipo de envío de métricas DISTRIBUTION representa la distribución estadística global de un conjunto de valores calculados en toda tu infraestructura distribuida en un intervalo de tiempo. Una DISTRIBUTION puede utilizarse para instrumentar objetos lógicos, como servicios, independientemente de los hosts subyacentes. + +A diferencia del tipo de métrica HISTOGRAM, que agrega en el Agent durante un intervalo de tiempo determinado, una métrica DISTRIBUTION envía todos los datos brutos a Datadog durante un intervalo de tiempo. La agregación se realiza en el servidor. Dado que la estructura de datos subyacente representa datos brutos, no agregados, las distribuciones ofrecen dos características principales: + +- Cálculo de agregaciones de percentiles +- Personalización del etiquetado + +Si envías valores `X` para una métrica DISTRIBUTION `` en un intervalo de tiempo determinado, las siguientes agregaciones están disponibles para consultas por defecto: + +`avg:` +: Representa la media de los valores `X` en el intervalo de tiempo.
+**Tipo dentro de la aplicación Datadog**: GAUGE + +`count:` +: Representa el número de puntos enviados en el intervalo de tiempo, `X`. A continuación, el Agent lo envía como COUNT.
+**Tipo dentro de la aplicación Datadog**: COUNT + +`max:` +: Representa el valor máximo de los valores de `X` enviados en el intervalo de tiempo.
+**Tipo dentro de la aplicación Datadog**: GAUGE + +`min:` +: Representa el valor mínimo de los `X` enviados en el intervalo de tiempo.
+**Tipo dentro de la aplicación Datadog**: GAUGE + +`sum:` +: Representa la suma de todos los valores de `X` enviados en el intervalo de tiempo.
+**Tipo dentro de la aplicación Datadog**: COUNT + +{{% /tab %}} +{{< /tabs >}} + +### Ejemplo + +{{< tabs >}} +{{% tab "COUNT" %}} + +Supongamos que estás enviando una métrica COUNT `notifications.sent`, desde un único host que ejecuta el Datadog Agent. Este host emite los siguientes valores en un intervalo de tiempo de descarga: `[1,1,1,2,2,2,3,3]`. + +El Agent suma todos los valores recibidos en un intervalo de tiempo. A continuación, envía el número total, en este caso `15`, como el valor de métrica COUNT. + +{{% /tab %}} +{{% tab "RATE" %}} + +Supongamos que estás enviando una métrica RATE `queue_messages.rate`, desde un único host que ejecuta el Datadog Agent. Este host emite los siguientes valores en un intervalo de tiempo de descarga: `[1,1,1,2,2,2,3,3]`. + +El Agent suma todos los valores recibidos en un intervalo de tiempo. A continuación, envía el número total dividido por el número total de segundos de este intervalo de tiempo. En este caso, si el intervalo de descarga es de 10 segundos, el valor enviado sería `1.5` como el valor de métrica RATE. + +{{% /tab %}} +{{% tab "GAUGE" %}} + +Supongamos que estás enviando una métrica GAUGE `temperature`, desde un único host que ejecuta el Datadog Agent. Este host emite los siguientes valores en un intervalo de tiempo de descarga: `[71,71,71,71,71,71,71.5]`. + +El Agent envía el último número reportado, en este caso `71.5`, como el valor de métrica GAUGE. + +{{% /tab %}} +{{% tab "HISTOGRAM" %}} + +Por ejemplo, supongamos que estás enviando una métrica HISTOGRAM, `request.response_time.histogram`, desde un servidor web que informa de los valores `[1,1,1,2,2,2,3,3]` en un intervalo de tiempo de descarga. Por defecto, el Agent envía las siguientes métricas a Datadog, que representan la distribución estadística de estos valores en este intervalo de tiempo: + +| Nombre de la métrica | Valor | Tipo dentro de la aplicación Datadog | +| ---------------------------------------------- | ------ | ------------------- | +| `request.response_time.histogram.avg` | `1.88` | GAUGE | +| `request.response_time.histogram.count` | `0.8` | RATE | +| `request.response_time.histogram.median` | `2` | GAUGE | +| `request.response_time.histogram.95percentile` | `3` | GAUGE | +| `request.response_time.histogram.max` | `3` | GAUGE | + +{{% /tab %}} +{{% tab "DISTRIBUTION" %}} + +Supongamos que estás enviando una métrica DISTRIBUTION, `request.response_time.distribution`, desde dos servidores web: `webserver:web_1` y `webserver:web_2`. Supongamos que en un periodo de descarga determinado, `webserver:web_1` informa la métrica con los valores `[1,1,1,2,2,2,3,3]` y que `webserver:web_2` informa la misma métrica con los valores `[1,1,2]`. Durante este intervalo de tiempo, las cinco agregaciones siguientes representan la distribución estadística global de todos los valores recopilados de ambos servidores web: + +| Nombre de la métrica | Valor | Tipo dentro de la aplicación Datadog | +| ------------------------------------------ | ------ | ------------------- | +| `avg:request.response_time.distribution` | `1.73` | GAUGE | +| `count:request.response_time.distribution` | `11` | COUNT | +| `max:request.response_time.distribution` | `3` | GAUGE | +| `min:request.response_time.distribution` | `1` | GAUGE | +| `sum:request.response_time.distribution` | `19` | COUNT | + +#### Cálculo de agregaciones de percentiles + +Al igual que otros tipos de métricas, como GAUGE or HISTOGRAM, el tipo de métrica DISTRIBUTION dispone de las siguientes agregaciones: `count` `min` , `max`, `sum` y `avg`. Las métricas de distribución se etiquetan inicialmente del mismo modo que las demás métricas (con etiquetas (tags) personalizadas definidas en el código). + +Se pueden añadir agregaciones de percentiles adicionales (`p50`, `p75`, `p90`, `p95`, `p99`) a las métricas de distribución. Si se añadieran agregaciones de percentiles a tu métrica de distribución dentro de la aplicación, las siguientes cinco agregaciones adicionales estarían disponibles para consultas: + +| Nombre de la métrica | Valor | Tipo dentro de la aplicación Datadog | +| ---------------------------------------- | ----- | ------------------- | +| `p50:request.response_time.distribution` | `2` | GAUGE | +| `p75:request.response_time.distribution` | `2` | GAUGE | +| `p90:request.response_time.distribution` | `3` | GAUGE | +| `p95:request.response_time.distribution` | `3` | GAUGE | +| `p99:request.response_time.distribution` | `3` | gauge | + +Es decir, para una métrica de distribución con agregaciones de percentiles añadidos durante un intervalo de tiempo determinado, están disponibles las 10 agregaciones siguientes: `count`, `sum`, `min`, `max`, `avg`, `p50`, `p75`, `p90`, `p95` y `p99`. + +#### Personalización del etiquetado + +Esta funcionalidad te permite controlar el etiquetado de métricas donde la granularidad a nivel de host no es necesaria. Consulta más información sobre [Metrics without LimitsTM][1]. + +**Nota**: La exclusión de etiquetas con `!` no se admite con esta función. + + +[1]: /es/metrics/metrics-without-limits/ +{{% /tab %}} +{{< /tabs >}} + +### Envío + +{{< tabs >}} +{{% tab "COUNT" %}} + +Envía tu tipo de métrica COUNT de una de las siguientes fuentes: + +| Fuente de envío | Método de envío (Python) | Tipo de envío | Tipo dentro de la aplicación Datadog | +| ----------------- | ------------------------------------ | --------------- | ------------------- | +| [Check del Agent][1] | `self.count(...)` | COUNT | COUNT | +| [Check del Agent][2] | `self.monotonic_count(...)` | COUNT | COUNT | +| [API][3] | `api.Metric.send(type="count", ...)` | COUNT | COUNT | +| [DogStatsD][4] | `dog.count(...)` | COUNT | RATE | +| [DogStatsD][4] | `dog.increment(...)` | COUNT | RATE | +| [DogStatsD][4] | `dog.decrement(...)` | COUNT | RATE | + +**Nota**: Cuando se envía un tipo de métrica COUNT a través de DogStatsD, la métrica aparece como RATE dentro de la aplicación para asegurar una comparación relevante a través de diferentes Agents. Consecuentemente, los recuentos de StatsD pueden aparecer con un valor decimal en Datadog (ya que están normalizados dentro de un intervalo de tiempo para reportar unidades por segundo). + + +[1]: /es/metrics/custom_metrics/agent_metrics_submission/?tab=count#count +[2]: /es/metrics/custom_metrics/agent_metrics_submission/?tab=count#monotonic-count +[3]: /es/api/v1/metrics/#submit-metrics +[4]: /es/metrics/custom_metrics/dogstatsd_metrics_submission/#count +{{% /tab %}} +{{% tab "RATE" %}} + +Envía tu tipo de métrica RATE de una de las siguientes fuentes: + +| Fuente de envío | Método de envío (Python) | Tipo de presentación | Tipo dentro de la aplicación Datadog | +| ----------------- | ----------------------------------- | --------------- | ------------------- | +| [Check del Agent][1] | `self.rate(...)` | RATE | GAUGE | +| [API][2] | `api.Metric.send(type="rate", ...)` | RATE | RATE | + +**Nota**: Al enviar un tipo de métrica RATE a través de DogStatsD, la métrica aparece como GAUGE dentro de la aplicación para garantizar una comparación pertinente entre diferentes Agents. + + +[1]: /es/metrics/custom_metrics/agent_metrics_submission/?tab=rate +[2]: /es/api/v1/metrics/#submit-metrics +{{% /tab %}} +{{% tab "GAUGE" %}} + +Envía tu tipo de métrica GAUGE de una de las siguientes fuentes: + +| Fuente de envío | Método de envío (Python) | Tipo de envío | Tipo dentro de la aplicación Datadog | +| ----------------- | ------------------------------------ | --------------- | ------------------- | +| [Check del Agent][1] | `self.gauge(...)` | GAUGE | GAUGE | +| [API][2] | `api.Metric.send(type="gauge", ...)` | GAUGE | GAUGE | +| [DogStatsD][3] | `dog.gauge(...)` | GAUGE | GAUGE | + + +[1]: /es/metrics/custom_metrics/agent_metrics_submission/?tab=gauge +[2]: /es/api/v1/metrics/#submit-metrics +[3]: /es/metrics/custom_metrics/dogstatsd_metrics_submission/#gauge +{{% /tab %}} +{{% tab "HISTOGRAM" %}} + +Envía tu tipo de métrica HISTOGRAM de una de las siguientes fuentes: + +| Fuente de envío | Método de envío (Python) | Tipo de envío | Tipos dentro de la aplicación Datadog | +| ----------------- | -------------------------- | --------------- | -------------------- | +| [Check del Agent][1] | `self.histogram(...)` | HISTOGRAM | GAUGE, RATE | +| [DogStatsD][2] | `dog.histogram(...)` | HISTOGRAM | GAUGE, RATE | + +Enviar una métrica TIMER al Datadog Agent equivale a enviar un tipo de métrica HISTOGRAM en DogStatsD (no confundir con los temporizadores del StatsD estándar). El [`TIMER` de DogStatsD][3] representa sólo datos de duración. Por ejemplo, el tiempo que tarda en ejecutarse una sección de código o el tiempo que tarda en renderizarse completamente una página. + + +[1]: /es/metrics/custom_metrics/agent_metrics_submission/?tab=histogram +[2]: /es/metrics/custom_metrics/dogstatsd_metrics_submission/#histogram +[3]: /es/metrics/custom_metrics/dogstatsd_metrics_submission/#timer +{{% /tab %}} +{{% tab "DISTRIBUTION" %}} + +Envía tu tipo de métrica DISTRIBUTION de una de las siguientes fuentes: + +| Fuente de envío | Método de envío (Python) | Tipo de envío | Tipos dentro de la aplicación Datadog | +| ----------------- | -------------------------- | --------------- | -------------------- | +| [DogStatsD][1] | `dog.distribution(...)` | DISTRIBUTION | GAUGE, COUNT | + + +[1]: /es/metrics/custom_metrics/dogstatsd_metrics_submission/#distribution +{{% /tab %}} +{{< /tabs >}} + +## Tipos de envío y tipos dentro de la aplicación Datadog + +A continuación se muestra un resumen de todas las fuentes y los métodos de envío de métricas disponibles. Esta tabla muestra la correspondencia entre el tipo de envío de métrica correspondiente y los tipos dentro de la aplicación: + +| Fuente de envío | Método de envío (Python) | Tipo de envío | Tipos dentro de la aplicación Datadog | +| ----------------- | ------------------------------------ | --------------- | -------------------- | +| [Check del Agent][9] | `self.count(...)` | COUNT | COUNT | +| [Check del Agent][10] | `self.monotonic_count(...)` | COUNT | COUNT | +| [Check del Agent][11] | `self.gauge(...)` | GAUGE | GAUGE | +| [Check del Agent][12] | `self.histogram(...)` | HISTOGRAM | GAUGE, RATE | +| [Check del Agent][13] | `self.rate(...)` | RATE | GAUGE | +| [API][7] | `api.Metric.send(type="count", ...)` | COUNT | COUNT | +| [API][7] | `api.Metric.send(type="gauge", ...)` | GAUGE | GAUGE | +| [API][7] | `api.Metric.send(type="rate", ...)` | RATE | RATE | +| [DogStatsD][14] | `dog.gauge(...)` | GAUGE | GAUGE | +| [DogStatsD][15] | `dog.distribution(...)` | DISTRIBUCIÓN | GAUGE, COUNT | +| [DogStatsD][16] | `dog.count(...)` | COUNT | RATE | +| [DogStatsD][16] | `dog.increment(...)` | COUNT | RATE | +| [DogStatsD][16] | `dog.decrement(...)` | COUNT | RATE | +| [DogStatsD][17] | `dog.set(...)` | SET (Conjunto) | GAUGE | +| [DogStatsD][18] | `dog.histogram(...)` | HISTOGRAM | gaugeTARIFA | +## Lectura adicional + +{{< partial name="whats-next/whats-next.html" >}} + +[1]: /es/metrics/custom_metrics/type_modifiers/ +[2]: /es/dashboards/functions/ +[3]: /es/metrics/summary/ +[4]: https://statsd.readthedocs.io/en/v3.3/types.html#sets +[5]: /es/metrics/custom_metrics/agent_metrics_submission/ +[6]: /es/metrics/custom_metrics/dogstatsd_metrics_submission/ +[7]: /es/api/v1/metrics/#submit-metrics +[8]: /es/developers/dogstatsd/#how-it-works +[9]: /es/metrics/custom_metrics/agent_metrics_submission/?tab=count#count +[10]: /es/metrics/custom_metrics/agent_metrics_submission/?tab=count#monotonic-count +[11]: /es/metrics/custom_metrics/agent_metrics_submission/?tab=gauge +[12]: /es/metrics/custom_metrics/agent_metrics_submission/?tab=histogram +[13]: /es/metrics/custom_metrics/agent_metrics_submission/?tab=rate +[14]: /es/metrics/custom_metrics/dogstatsd_metrics_submission/#gauge +[15]: /es/metrics/custom_metrics/dogstatsd_metrics_submission/#distribution +[16]: /es/metrics/custom_metrics/dogstatsd_metrics_submission/#count +[17]: /es/metrics/custom_metrics/dogstatsd_metrics_submission/#set +[18]: /es/metrics/custom_metrics/dogstatsd_metrics_submission/#histogram \ No newline at end of file diff --git a/content/es/security/application_security/threats/add-user-info.md b/content/es/security/application_security/threats/add-user-info.md index fb3542b23e75a..ebe282eb922c0 100644 --- a/content/es/security/application_security/threats/add-user-info.md +++ b/content/es/security/application_security/threats/add-user-info.md @@ -594,7 +594,7 @@ En los siguientes ejemplos se muestra cómo rastrear los eventos de inicio de se {{< /programming-lang >}} {{< programming-lang lang="nodejs" >}} -Empezando en dd-trace-js v3.13.1, se puede utilizar la API del rastreador de NodeJS para rastrear los eventos de los usuarios. +Empezando en dd-trace-js v3.13.1, se puede utilizar la API del rastreador de Node.js para rastrear los eventos de los usuarios. En los siguientes ejemplos se muestra cómo rastrear los eventos de inicio de sesión o eventos personalizados (utilizando el registro como ejemplo). diff --git a/content/es/security/application_security/troubleshooting.md b/content/es/security/application_security/troubleshooting.md index 774c199963e96..955565afb30a6 100644 --- a/content/es/security/application_security/troubleshooting.md +++ b/content/es/security/application_security/troubleshooting.md @@ -551,7 +551,7 @@ Consulte la documentación de configuración del producto Application Security p ### Garantizar la comunicación de los datos de telemetría -Asegúrate de que la variable de entorno `DD_INSTRUMENTATION_TELEMETRY_ENABLED` (`DD_TRACE_TELEMETRY_ENABLED` para NodeJS) está configurada como `true` o que la propiedad del sistema correspondiente a tu lenguaje está habilitada. Por ejemplo, en Java: `-Ddd.instrumentation.telemetry.enabled=true` +Asegúrate de que la variable de entorno `DD_INSTRUMENTATION_TELEMETRY_ENABLED` (`DD_TRACE_TELEMETRY_ENABLED` para Node.js) está configurada como `true` o que la propiedad del sistema correspondiente a tu lenguaje está habilitada. Por ejemplo, en Java: `-Ddd.instrumentation.telemetry.enabled=true` ## Deshabilitar la gestión de amenazas y la protección diff --git a/content/es/serverless/guide/serverless_tracing_and_bundlers.md b/content/es/serverless/guide/serverless_tracing_and_bundlers.md index 5fee6075a6d3b..fab8989d107a3 100644 --- a/content/es/serverless/guide/serverless_tracing_and_bundlers.md +++ b/content/es/serverless/guide/serverless_tracing_and_bundlers.md @@ -156,7 +156,7 @@ Si despliegas funciones de Lambda de Node.js con la construcción `NodeJsFunctio return [] } }, - externalModules: ['@aws-sdk/client-dynamodb'] // The AWS SDK is included as part of the NodeJS Lambda runtime + externalModules: ['@aws-sdk/client-dynamodb'] // The AWS SDK is included as part of the Node.js Lambda runtime } }); ``` diff --git a/content/es/serverless/libraries_integrations/cli.md b/content/es/serverless/libraries_integrations/cli.md index ec9de809ecd38..6107ad2110f1f 100644 --- a/content/es/serverless/libraries_integrations/cli.md +++ b/content/es/serverless/libraries_integrations/cli.md @@ -113,7 +113,7 @@ Puedes pasar los siguientes argumentos a `instrument` para especificar su compor | `--no-source-code-integration` | | Deshabilita la integración del código fuente de Datadog. | | | `--upload-git-metadata` | `-u` | Lo utilizas si quieres habilitar la carga de metadatos de Git, como parte de la integración del código fuente. La carga de metadatos de Git solo es necesaria si no tienes instalada la integración de Github de Datadog. | `true` | | `--no-upload-git-metadata` | | Deshabilita la carga de metadatos de Git, como parte de la integración del código fuente. Utiliza esta opción si tienes instalada la integración de Github de Datadog, ya que hace que la carga de metadatos de Git sea innecesaria. | | -| `--apm-flush-deadline` | | Se utiliza para determinar cuándo enviar tramos antes de que se agote el tiempo de espera, en milisegundos. Cuando el tiempo restante en una invocación de AWS Lambda es inferior al valor establecido, el rastreador intenta enviar el tramo activo actual y todos los tramos finalizados. Esto es compatible con NodeJS y Python. El valor por defecto es `100` milisegundos. | | +| `--apm-flush-deadline` | | Se utiliza para determinar cuándo enviar tramos antes de que se agote el tiempo de espera, en milisegundos. Cuando el tiempo restante en una invocación de AWS Lambda es inferior al valor establecido, el rastreador intenta enviar el tramo activo actual y todos los tramos finalizados. Esto es compatible con Node.js y Python. El valor por defecto es `100` milisegundos. | |
#### `uninstrument` diff --git a/content/es/serverless/libraries_integrations/macro.md b/content/es/serverless/libraries_integrations/macro.md index 08522731f7b5d..a046d5b67e508 100644 --- a/content/es/serverless/libraries_integrations/macro.md +++ b/content/es/serverless/libraries_integrations/macro.md @@ -139,13 +139,13 @@ Para configurar más tu complemento, utiliza los siguientes parámetros personal | `tags` | Una lista separada por comas de pares de clave:valor como una sola cadena. Cuando se configura junto con `extensionLayerVersion`, se añade una variable de entorno `DD_TAGS` en todas las funciones Lambda con el valor proporcionado. Cuando se configura junto con `forwarderArn`, la macro analiza la cadena y configura cada par de clave:valor como una etiqueta en todas las funciones Lambda. | | `logLevel` | Configura el nivel de log. Configura en `DEBUG` para un registro extendido. | | `captureLambdaPayload` | Etiqueta automáticamente el tramo (span) de ejecución de la función con cargas útiles de solicitud y respuesta, para que puedan mostrarse en la aplicación de APM. | -| `enableColdStartTracing` | Configurado en `false` para desactivar el Rastreo de inicio en frío. Se utiliza en NodeJS y Python. Por defecto es `true`. | +| `enableColdStartTracing` | Configurado en `false` para desactivar el Rastreo de inicio en frío. Se utiliza en Node.js y Python. Por defecto es `true`. | | `coldStartTraceMinDuration` | Configura la duración mínima (en milisegundos) de un evento de carga de módulo que se va a rastrear a través del rastreo de inicio en frío. Número. Por defecto es `3`. | | `coldStartTraceSkipLibs` | Opcionalmente omitir la creación de tramos de inicio en frío para un lista separada por comas de bibliotecas. Útil para limitar la profundidad u omitir bibliotecas conocidas. El valor por defecto depende del tiempo de ejecución. | -| `enableProfiling` | Habilita el Datadog Continuous Profiler con `true`. Compatible con Beta para NodeJS y Python. Por defecto en `false`. | -| `encodeAuthorizerContext` | Cuando se configure en `true` para los autorizadores Lambda, el contexto del rastreo se codificará en la respuesta para la propagación. Compatible con NodeJS y Python. Por defecto es `true`. | -| `decodeAuthorizerContext` | Cuando se configure en `true` para Lambdas que están autorizadas a través de autorizadores Lambda, analizará y utilizará el contexto de rastreo codificado (si se lo encuentra). Compatible con NodeJS y Python. Por defecto es `true`. | -| `apmFlushDeadline` | Se utiliza para determinar cuándo enviar tramos antes de que se agote el tiempo, en milisegundos. Cuando el tiempo restante en una invocación de AWS Lambda es menor que el valor configurado, el rastreador intenta enviar los tramos activos actuales y todos los tramos finalizados. Compatible con NodeJS y Python. El valor por defecto es `100` milisegundos. | +| `enableProfiling` | Habilita el Datadog Continuous Profiler con `true`. Compatible con Beta para Node.js y Python. Por defecto en `false`. | +| `encodeAuthorizerContext` | Cuando se configure en `true` para los autorizadores Lambda, el contexto del rastreo se codificará en la respuesta para la propagación. Compatible con Node.js y Python. Por defecto es `true`. | +| `decodeAuthorizerContext` | Cuando se configure en `true` para Lambdas que están autorizadas a través de autorizadores Lambda, analizará y utilizará el contexto de rastreo codificado (si se lo encuentra). Compatible con Node.js y Python. Por defecto es `true`. | +| `apmFlushDeadline` | Se utiliza para determinar cuándo enviar tramos antes de que se agote el tiempo, en milisegundos. Cuando el tiempo restante en una invocación de AWS Lambda es menor que el valor configurado, el rastreador intenta enviar los tramos activos actuales y todos los tramos finalizados. Compatible con Node.js y Python. El valor por defecto es `100` milisegundos. | ## Cómo funciona diff --git a/content/es/serverless/libraries_integrations/plugin.md b/content/es/serverless/libraries_integrations/plugin.md index 365eb657e269e..9ef5f1be937e5 100644 --- a/content/es/serverless/libraries_integrations/plugin.md +++ b/content/es/serverless/libraries_integrations/plugin.md @@ -62,14 +62,14 @@ Para configurar más tu complemento, utiliza los siguientes parámetros personal | `failOnError` | Cuando se configura, este complemento genera un error si no se crea o actualiza algún monitor Datadog personalizado. Esto ocurre después del despliegue, pero hará que el resultado de `serverless deploy` devuelva un código de salida distinto de cero (para un error de la CI de usuario). Por defecto es `false`. | | `logLevel` | El nivel del log, configurado en `DEBUG` para un registro extendido. | | `skipCloudformationOutputs` | Se configura en `true` si deseas omitir añadir Datadog Cloudformation Outputs para tu stack. Esto es útil si se está ejecutando en el límite de 200 salidas que puede causar un error en la creación del stack. | -| `enableColdStartTracing` | Se configura en `false` para desactivar el rastreo de inicio en frío. Se utiliza en NodeJS y Python. Por defecto es `true`. | +| `enableColdStartTracing` | Se configura en `false` para desactivar el rastreo de inicio en frío. Se utiliza en Node.js y Python. Por defecto es `true`. | | `coldStartTraceMinDuration` | Configura la duración mínima (en milisegundos) de un evento de carga de un módulo que se va a rastrear a través del rastreo de inicio en frío. Número. Por defecto es `3`. | | `coldStartTraceSkipLibs` | Omite opcionalmente la creación de tramos de inicio en frío para un lista separada por comas de bibliotecas. Es útil para limitar la profundidad u omitir bibliotecas conocidas. El valor por defecto depende del tiempo de ejecución. | | `subdomain` | Configura el subdominio opcional que se utilizará para las URL de las aplicaciones que se imprimen en la salida. Por defecto es `app`. | -| `enableProfiling` | Activa el Datadog Continuous Profiler con `true`. Es compatible en Beta con NodeJS y Python. Por defecto es `false`. | -| `encodeAuthorizerContext` | Cuando se configura en `true` para los autorizadores Lambda, el contexto de rastreo se codificará en la respuesta para la propagación. Compatible con NodeJS y Python. Por defecto es `true`. | -| `decodeAuthorizerContext` | Cuando se configura en `true` para Lambdas que están autorizadas a través de autorizadores Lambda, analizará y utilizará el contexto de rastreo codificado (si se encuentra). Compatible con NodeJS y Python. Por defecto es `true`. | -| `apmFlushDeadline` | Se utiliza para determinar cuándo enviar tramos antes de que se agote el tiempo, en milisegundos. Cuando el tiempo restante en una invocación de AWS Lambda es inferior al valor configurado, el rastreador intenta enviar los tramos (spans) activos actuales y todos los tramos finalizados. Compatible con NodeJS y Python. El valor por defecto es `100` milisegundos. | +| `enableProfiling` | Activa el Datadog Continuous Profiler con `true`. Es compatible en Beta con Node.js y Python. Por defecto es `false`. | +| `encodeAuthorizerContext` | Cuando se configura en `true` para los autorizadores Lambda, el contexto de rastreo se codificará en la respuesta para la propagación. Compatible con Node.js y Python. Por defecto es `true`. | +| `decodeAuthorizerContext` | Cuando se configura en `true` para Lambdas que están autorizadas a través de autorizadores Lambda, analizará y utilizará el contexto de rastreo codificado (si se encuentra). Compatible con Node.js y Python. Por defecto es `true`. | +| `apmFlushDeadline` | Se utiliza para determinar cuándo enviar tramos antes de que se agote el tiempo, en milisegundos. Cuando el tiempo restante en una invocación de AWS Lambda es inferior al valor configurado, el rastreador intenta enviar los tramos (spans) activos actuales y todos los tramos finalizados. Compatible con Node.js y Python. El valor por defecto es `100` milisegundos. | | `enableStepFunctionsTracing` | Activa la suscripción automática de los grupos de logs de Datadog Forwarder a Step Functions y el rastreo de Step Functions. Si no hay grupos de logs de Step Functions configurados, se crearán automáticamente. Requiere la configuración de `forwarderArn`. Por defecto es `false`. | | `propagateUpstreamTrace` | Cuando se configura en `true`, las trazas de invocaciones de Stepfunction aguas abajo se fusionan con las invocaciones de Stepfunction aguas arriba. Por defecto es `false`. | | `redirectHandlers` | Opcionalmente desactiva la redirección del controlador si se configura en `false`. Esto solo debe configurarse en `false` cuando APM está totalmente desactivada. Por defecto es `true`. | diff --git a/content/es/service_management/incident_management/incident_details.md b/content/es/service_management/incident_management/incident_details.md deleted file mode 100644 index 3a5a1544f5ee0..0000000000000 --- a/content/es/service_management/incident_management/incident_details.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -aliases: -- /es/monitors/incident_management/incident_details -description: Gestionar el contexto y el trabajo para una incidencia -further_reading: -- link: dashboards/querying/#incident-management-analytics - tag: Documentación - text: Análisis de la gestión de incidencias -title: Página de detalles de la incidencia ---- - -## Información general - -{{< img src="/service_management/incidents/incident_details/incident_overview_page.png" alt="Página de detalles de incidencias de una incidencia en estado activo SEV-4" style="width:100%;">}} - -Cada incidencia en Datadog tiene su propia página de Detalles de la incidencia donde puedes gestionar los campos de propiedades, señales, tareas, documentos, personas involucradas y notificaciones. La página Detalles de la incidencia está disponible después de [crear una nueva incidencia][1]. La página Detalles de la incidencia contiene un encabezado global para acceder rápidamente a las acciones clave, mientras que el resto de la página se divide en diferentes secciones utilizando pestañas para agrupar los datos relacionados de la incidencia. La primera de estas secciones es la Descripción general. - -## Encabezado global - -El encabezado global proporciona acceso a los selectores [Estado y Gravedad][2], y se vincula a tus [Integraciones de incidencias][3]. Para obtener más información sobre cómo configurar enlaces automáticos con cada nueva incidencia para los enlaces de Slack y Microsoft Teams, consulta [Configuración de la incidencia][4]. - -Después de mover una incidencia al estado resuelto, aparece una opción en el encabezado para generar un notebook de análisis retrospectivo utilizando una [plantilla de análisis retrospectivo][5]. Configura tus plantillas de análisis retrospectivo en la página [Configuración de la incidencia][6] para predefinir la estructura y el contenido de tus análisis retrospectivos. - -## Sección general de detalles de la incidencia - -Utiliza la sección Resumen para especificar las propiedades de una incidencia y definir el impacto en el cliente. - -Por defecto, todas las incidencias tienen las siguientes propiedades: - -* Causa raíz -* Servicios -* Teams -* Método de detección -* Resumen - -Las propiedades se dividen en las tres secciones siguientes: - -* ¿Qué ha pasado? -* ¿Por qué ocurrió? -* Atributos - -En [Configuración de la incidencia][7], añade campos de propiedades adicionales con los pares de `:` de tus etiquetas (tags) de métricas de Datadog, o crea otros personalizados. Asigna valores a las propiedades de una incidencia para poder buscar un subconjunto de incidencias en la [Página principal de incidencias][8] y para formar consultas en el [Análisis de gestión de incidencias][9]. También puedes reordenar los campos de propiedades y moverlos a diferentes encabezados para que las propiedades más importantes estén en localizaciones destacadas. - -Si tu incidencia está relacionada con el cliente, especifica los detalles en la sección Impacto: - -1. Haz clic en **Add** (Añadir). -2. Especifica una fecha y hora de inicio del impacto. -3. Especifica una fecha y hora de finalización del impacto o déjalo en blanco si el impacto aún está en curso. -4. Describe la naturaleza del impacto sobre los clientes en `Scope of impact`. -5. Haz clic en **Save** (Guardar). - -Además de albergar los campos de tus propiedades, la sección Descripción general también proporciona los siguientes módulos de resumen: - -1. *Línea de tiempo condensada*: muestra los momentos en los que la incidencia cambia de estado, así como cuándo comenzó y finalizó el impacto para obtener una vista clara del ciclo de vida de la incidencia. -2. *Notificaciones más recientes*: muestra la notificación más reciente enviada para la incidencia, con acceso rápido a la lista completa de notificaciones en la [sección de Notificación](#notifications-section). -3. *Tareas pendientes*: muestra la tarea incompleta más reciente, con acceso rápido a la lista completa de las tareas en la [sección de Remediación] (#remediation-section). -4. *Personas involucradas*: muestra el encargado actual de la incidencia y los avatares del resto de las personas involucradas asignadas a la incidencia. -5. *Entradas recientes en la línea de tiempo*: muestra las cinco entradas más recientes de la línea de tiempo de la incidencia, con acceso rápido para ver toda la [sección Línea de tiempo](#timeline-section). - -## Sección Línea de tiempo - -{{< img src="/service_management/incidents/incident_details/incident_details_timeline.png" alt="Detalles de la incidencia Vista de la línea de tiempo que muestra la progresión de un caso que escaló a una incidencia" style="width:100%;">}} - -La línea de tiempo de la incidencia es la principal fuente de información del trabajo realizado durante una incidencia. A medida que se realizan acciones, se añaden nuevas celdas a la línea de tiempo en orden cronológico para capturar los cambios realizados, la persona que realizó el cambio y la hora en que se realizaron los cambios. - -### Tipos de contenido - -Cada celda tiene su propio tipo de contenido, que indica el tipo de información que contiene: - -| Tipo de contenido | Descripción | -| ------------------ | ------------------------------------------------------------------------------------------------------ | -| Nota de la persona involucrada | Nota escrita manualmente por una persona involucrada en una incidencia. Las notas de respuesta tienen los siguientes subtipos:
- *Gráfico*: la nota de respuesta contiene uno o más gráficos de Datadog
- *Enlace*: la nota de respuesta contiene un hipervínculo
- *Código*: la nota de respuesta contiene texto enmascarado en sintaxis Markdown para bloques de código -| Actualización de la incidencia | Cualquier cambio realizado en las propiedades de una incidencia (incluidos el estado y la gravedad) o su impacto. -| Actualización de la integración | Cualquier cambio realizado a través de las [integraciones] del producto de gestión de incidencias[3]. -| Tarea | Cualquier cambio realizado en las tareas de la incidencia en la sección Remediación de la página Detalles de la incidencia. -| Notificación enviada | Una actualización cuando una persona involucrada en la incidencia envía una notificación de forma manual. - -Añade notas de respuesta directamente a la línea de tiempo mediante el cuadro de texto situado justo debajo de las pestañas para cambiar entre las distintas secciones de la página Detalles de la incidencia. Personaliza la marca de tiempo de la nota de respuesta a la hora de la creación para capturar información importante que era relevante en un momento anterior en el orden cronológico de la línea de tiempo. Para las notas de respuesta de tu autoría, puedes editar el contenido o la marca de tiempo, o eliminar la nota por completo. También puedes copiar un enlace a una celda específica para compartirlo con tus compañeros de equipo. Las notas de respuesta se pueden [añadir a la cronología desde Slack][10]. - -En el caso concreto de las celdas de gráficos, las definiciones de gráficos se almacenan mediante URL compartidas para gráficos si están habilitadas en los [Parámetros de organización][11]. Cuando una celda de gráfico se añade a la línea de tiempo, tiene estados interactivos completos por los que puedes pasar el cursor como los que se encuentran en dashboards, notebooks y otras páginas. Después de 24 horas de ser añadidos a la línea de tiempo, los gráficos son reemplazados por imágenes estáticas que capturan lo que el gráfico estaba mostrando. Esto es para asegurar que los gráficos que muestran datos de corta retención tengan imágenes de respaldo capturadas incluso después de que los datos en vivo hayan expirado. - -Por defecto, las celdas de la línea de tiempo se ordenan en `oldest first`, pero puede cambiarse a `newest first` utilizando el botón situado en la parte superior de la línea de tiempo. - -## Sección de Remediación - -Utiliza la sección Remediación para almacenar cualquier documento o recurso que sea pertinente para el proceso de remediación de una incidencia, así como para realizar un seguimiento de las tareas clave para el proceso de remediación. - -Los documentos pueden añadirse pegando la URL del documento y dando al enlace un nombre legible para un acceso rápido. - -Las tareas de incidencias se crean directamente en la sección Remediación y a través de la [integración con Slack] de Datadog[12]. - -En la sección Remediación, escribe la descripción de tu tarea en el cuadro de texto de creación. Para asignar una tarea a un usuario de Datadog, escribe `@` en el cuadro de texto de descripción, o utiliza la columna `Assignees` una vez creada la tarea. Una tarea de incidencia puede tener más de un asignado. Después de crear una tarea, también se le puede asignar una fecha de vencimiento. - -A medida que se van terminando las tareas, se pueden marcar como completadas al hacer clic en la casilla de verificación situada a la izquierda de la descripción de la tarea. Si tienes un gran número de tareas, puedes filtrarlas buscando por palabras clave u ocultando de la vista las tareas completadas. - -## Sección Equipo de respuesta - -
-Esta función está en fase beta abierta. -
- -{{< img src="/service_management/incidents/incident_details/incident_response_team.png" alt="Sección Detalles de la incidencia y equipo de respuesta que muestra el Encargado de la incidencia, la Persona involucrada y el Líder de comunicación" style="width:100%;" >}} - -En la sección Equipo de respuesta, puedes formar tu equipo de respuesta añadiendo otros usuarios y asignándoles funciones que desempeñar en la proceso de resolución de una incidencia. Los dos tipos de personas involucradas predeterminadas que brinda Datadog son: - -1. `Incident Commander`: la persona responsable de dirigir el equipo de respuesta -3. `Responder`: una persona que contribuye activamente a investigar una incidencia y resolver su problema subyacente - -Si deseas crear roles personalizados de persona involucrada, puedes hacerlo en la [Configuración de incidentes para tipos de persona involucrada][13]. Esto te permite crear nuevos tipos de roles con nombres y descripciones personalizados. También te permite elegir si un tipo de persona involucrada debe ser un rol unipersonal o multipersonal. - -**Nota:** Estos roles no están relacionados con los que se encuentran en el sistema [Configuración del control de acceso basado en roles (RBAC)][14]. Los roles de RBAC controlan los permisos de un usuario para acceder a determinadas funciones en Datadog. El sistema de Tipos de personas involucradas en la gestión de incidencias no cambia los permisos de un usuario en ninguna capacidad. Se trata más bien de acercar a las personas involucradas a sus incidentes y darles roles documentados en tu proceso de respuesta para obtener visibilidad. - -Si añades a alguien como persona involucrada, se le notifica a través del correo electrónico asociado a su cuenta de Datadog. Cualquiera puede cambiar el rol de una persona involucrada, pero solo puedes eliminar a alguien del Equipo de respuesta de una incidencia si tiene asignado el rol general de `Responder` y no tiene actividad en la incidencia. Si ya hay un `Incident Commander` asignado a una incidencia, la asignación de otro individuo como `Incident Commander` le transfiere ese rol. Al anterior `Incident Commander` se le reasigna el rol general de `Responder`. Una reasignación similar ocurre cada vez que se reasigna uno de los roles personalizados de una persona. - -La lista del Equipo de respuesta también guarda la fecha y hora en que un individuo fue agregado originalmente al equipo de respuesta de una incidencia, así como la fecha y hora en que participó por última vez con algo a la línea de tiempo de la incidencia. - -## Sección Notificaciones - -{{< img src="service_management/incidents/incident_notifications.jpeg" alt="Notificaciones de la incidencia" style="width:80%;">}} - -Todas las notificaciones de las partes interesadas para una incidencia se consolidan en la sección Notificaciones. -Puedes crear manualmente, guardar como borrador y enviar notificaciones directamente desde esta página. Las notificaciones automatizadas enviadas por [Reglas de notificación][15] para la incidencia en cuestión también se enumeran en esta sección. - -Para crear una notificación manual: - -1. Haz clic en el botón **+New Notification** (+ Notificación nueva) en la parte superior derecha de la sección. -2. Introduce los destinatarios deseados. Estos pueden ser cualquier destino de notificación compatible con Datadog incluidos correos electrónicos, canales de Slack, usuarios de PagerDuty, webhooks y más. -3. Selecciona una [Plantilla de mensaje][16]. -4. Edita el título y el mensaje de tu notificación según sea necesario utilizando Markdown y cualquier variable compatible de la plantilla de incidencia al escribir `{{`. - - Las variables de plantilla se basan en las propiedades de una incidencia. Antes de enviar un mensaje, todas las variables de plantilla se sustituyen por el valor correspondiente de la propiedad referenciada disponible para el mensaje en el momento de su envío. -5. Utiliza la variable `{{incident.created}}` para personalizar la zona horaria de tu mensaje. Esta variable de plantilla mostrará la opción para establecer tu zona horaria variable. -6. Envía tu notificación o guárdala como borrador. - -La sección Notificaciones está separada en listas: Borradores y Enviados. - -Se muestran las dos listas: - -1. Los destinatarios (previstos) de notificación -2. El contenido del mensaje de notificación y los mensajes de renotificación enviados -3. Fecha de la última actualización de notificación -4. El autor original de la notificación - -La lista Enviado también muestra si una notificación fue enviada de forma manual o automática por una regla de notificación. Si la notificación fue automatizada, se muestra la regla que activó la notificación. - -## Empezando - -Trabaja con un flujo de trabajo de ejemplo en la guía [Empezando con la gestión de incidencias][17]. - -## Leer más - -{{< partial name="whats-next/whats-next.html" >}} - -[1]: /es/service_management/incident_management/#creating-an-incident -[2]: /es/service_management/incident_management/#describing-the-incident -[3]: /es/service_management/incident_management/#integrations -[4]: /es/service_management/incident_management/incident_settings#integrations -[5]: /es/service_management/incident_management/incident_settings#postmortem-templates -[6]: https://app.datadoghq.com/incidents/settings#Postmortems -[7]: https://app.datadoghq.com/incidents/settings#Property-Fields -[8]: https://app.datadoghq.com/incidents -[9]: /es/service_management/incident_management/analytics -[10]: /es/integrations/slack/?tab=slackapplicationus#using-datadog-incidents -[11]: https://app.datadoghq.com/organization-settings/public-sharing/settings -[12]: /es/integrations/slack/?tab=slackapplicationus#manage-incident-tasks -[13]: /es/service_management/incident_management/incident_settings/#responder-types -[14]: /es/account_management/rbac/?tab=datadogapplication -[15]: /es/service_management/incident_management/incident_settings#rules -[16]: /es/service_management/incident_management/incident_settings#message-templates -[17]: /es/getting_started/incident_management \ No newline at end of file diff --git a/content/es/tracing/guide/agent-5-tracing-setup.md b/content/es/tracing/guide/agent-5-tracing-setup.md index d93e316b68e2f..2f9516af5a352 100644 --- a/content/es/tracing/guide/agent-5-tracing-setup.md +++ b/content/es/tracing/guide/agent-5-tracing-setup.md @@ -39,7 +39,7 @@ Para obtener más información, consulta [la página de Docker][7]. {{< nextlink href="tracing/setup/python" tag="Python" >}}Instrumentación en lenguaje Python.{{< /nextlink >}} {{< nextlink href="tracing/setup/ruby" tag="Ruby" >}}Instrumentación en lenguaje Ruby.{{< /nextlink >}} {{< nextlink href="tracing/setup/go" tag="Go" >}}Instrumentación en lenguaje Go.{{< /nextlink >}} - {{< nextlink href="tracing/setup/nodejs" tag="Nodejs" >}}Instrumentación en lenguaje Node.js.{{< /nextlink >}} + {{< nextlink href="tracing/setup/nodejs" tag="Node.js" >}}Instrumentación en lenguaje Node.js.{{< /nextlink >}} {{< nextlink href="tracing/setup/dotnet" tag=".NET" >}}Instrumentación en lenguaje .NET.{{< /nextlink >}} {{< nextlink href="tracing/setup/php" tag="PHP" >}}Instrumentación en lenguaje PHP.{{< /nextlink >}} {{< /whatsnext >}} diff --git a/content/es/tracing/guide/ignoring_apm_resources.md b/content/es/tracing/guide/ignoring_apm_resources.md index 9c6f7e6acd6bb..db990208bdebb 100644 --- a/content/es/tracing/guide/ignoring_apm_resources.md +++ b/content/es/tracing/guide/ignoring_apm_resources.md @@ -392,7 +392,7 @@ Algunos de los rastreadores específicos del lenguaje tienen una opción para mo
Importante: Si la solicitud está asociada a una traza distribuida, la traza resultante puede tener imprecisiones de muestreo si descartas partes de ella debido a estas reglas de filtrado.
-{{< contenedor de lenguajes de programación lenguajes="Ruby,Python,NodeJS,Java" >}} +{{< contenedor de lenguajes de programación lenguajes="Ruby,Python,Node.js,Java" >}} {{< lenguaje de programación lenguaje="ruby" >}} diff --git a/content/es/tracing/guide/inferred-service-opt-in.md b/content/es/tracing/guide/inferred-service-opt-in.md index 32c5901c65e7a..83093d0e44d0a 100644 --- a/content/es/tracing/guide/inferred-service-opt-in.md +++ b/content/es/tracing/guide/inferred-service-opt-in.md @@ -26,7 +26,7 @@ Con la nueva experiencia de entidades inferidas, puedes filtrar las entradas del Para determinar los nombres y tipos de las dependencias de servicio inferidas, Datadog utiliza atributos de tramo estándar y los asigna a atributos `peer.*`. Para consultar la lista completa de atributos `peer.*`, consulta [Nomenclatura de dependencias de servicio inferidas](#inferred-service-dependencies-nomemclature). Las API externas inferidas utilizan el esquema de nomenclatura por defecto `net.peer.name`. Por ejemplo, `api.stripe.com`, `api.twilio.com`, `us6.api.mailchimp.com`. Las bases de datos inferidas utilizan el esquema de nomenclatura por defecto `db.instance`. -Si utilizas el rastreador de Go, Java, NodeJS, PHP, .NET o Ruby, puedes personalizar los nombres predeterminados de las entidades inferidas. +Si utilizas el rastreador de Go, Java, Node.js, PHP, .NET o Ruby, puedes personalizar los nombres predeterminados de las entidades inferidas. **Nota:** Si configuras monitores, dashboards, o notebooks para un determinado servicio inferido durante la fase beta, puede que necesites actualizarlos si el esquema de nombres cambia. Más información sobre los pasos de migración en las [instrucciones de elección](#opt-in). @@ -150,9 +150,9 @@ Para ello, añade las siguientes variables de entorno o propiedades del sistema {{% /tab %}} -{{% tab "NodeJS" %}} +{{% tab "Node.js" %}} -Las versiones mínimas del rastreador de NodeJS requeridas son [2.44.0][1], [3.31.0][2], o [4.10.0][3]. Las actualizaciones periódicas a la última versión son recomendadas para acceder a los cambios y correcciones de errores. +Las versiones mínimas del rastreador de Node.js requeridas son [2.44.0][1], [3.31.0][2], o [4.10.0][3]. Las actualizaciones periódicas a la última versión son recomendadas para acceder a los cambios y correcciones de errores. Para ello, añade las siguientes variables de entorno o propiedades del sistema a la configuración de tu rastreador: diff --git a/content/es/tracing/trace_collection/automatic_instrumentation/dd_libraries/nodejs.md b/content/es/tracing/trace_collection/automatic_instrumentation/dd_libraries/nodejs.md index 8c300f49912fd..8771f30fd643a 100644 --- a/content/es/tracing/trace_collection/automatic_instrumentation/dd_libraries/nodejs.md +++ b/content/es/tracing/trace_collection/automatic_instrumentation/dd_libraries/nodejs.md @@ -9,7 +9,7 @@ aliases: - /es/tracing/setup_overview/nodejs - /es/tracing/setup_overview/setup/nodejs - /es/tracing/trace_collection/dd_libraries/nodejs/ -code_lang: NodeJS +code_lang: nodejs code_lang_weight: 30 further_reading: - link: https://github.com/DataDog/dd-trace-js diff --git a/content/es/tracing/trace_collection/custom_instrumentation/opentracing/_index.md b/content/es/tracing/trace_collection/custom_instrumentation/opentracing/_index.md index 3b246da574323..76476d8af4d14 100644 --- a/content/es/tracing/trace_collection/custom_instrumentation/opentracing/_index.md +++ b/content/es/tracing/trace_collection/custom_instrumentation/opentracing/_index.md @@ -18,7 +18,7 @@ Lea más para tu lenguaje: {{< nextlink href="/tracing/trace_collection/custom_instrumentation/opentracing/python" >}}Python{{< /nextlink >}} {{< nextlink href="/tracing/trace_collection/custom_instrumentation/opentracing/ruby" >}}Ruby{{< /nextlink >}} {{< nextlink href="/tracing/trace_collection/custom_instrumentation/opentracing/go" >}}Go{{< /nextlink >}} - {{< nextlink href="/tracing/trace_collection/custom_instrumentation/opentracing/nodejs" >}}NodeJS{{< /nextlink >}} + {{< nextlink href="/tracing/trace_collection/custom_instrumentation/opentracing/nodejs" >}}Node.js{{< /nextlink >}} {{< nextlink href="/tracing/trace_collection/custom_instrumentation/opentracing/php" >}}PHP{{< /nextlink >}} {{< nextlink href="/tracing/trace_collection/custom_instrumentation/opentracing/dotnet" >}}.NET{{< /nextlink >}} {{< /whatsnext >}} diff --git a/content/es/tracing/trace_collection/library_config/nodejs.md b/content/es/tracing/trace_collection/library_config/nodejs.md index 1914d74930bda..169a71f94c58f 100644 --- a/content/es/tracing/trace_collection/library_config/nodejs.md +++ b/content/es/tracing/trace_collection/library_config/nodejs.md @@ -1,5 +1,5 @@ --- -code_lang: NodeJS +code_lang: nodejs code_lang_weight: 30 further_reading: - link: https://github.com/DataDog/dd-trace-js diff --git a/content/es/tracing/trace_collection/library_injection_local.md b/content/es/tracing/trace_collection/library_injection_local.md index 6c55dc0e4b6e7..4629ee2dadaff 100644 --- a/content/es/tracing/trace_collection/library_injection_local.md +++ b/content/es/tracing/trace_collection/library_injection_local.md @@ -30,7 +30,7 @@ Para obtener más información sobre el controlador de admisión Kubernetes, con ## Requisitos * Kubernetes v1.14 o posterior -* Datadog [Cluster Agent v7.40 o posterior][3], para Java, Python y NodeJS, y Datadog [Cluster Agent v7.44 o posterior][3], para .NET y Ruby. +* Datadog [Cluster Agent v7.40 o posterior][3], para Java, Python y Node.js, y Datadog [Cluster Agent v7.44 o posterior][3], para .NET y Ruby. * Controlador de admisión Datadog habilitado. **Nota**: En el chart de Helm v2.35.0 y posteriores, el controlador de admisión Datadog está habilitado por defecto en el Cluster Agent. * Para Python, las aplicaciones uWSGI no son compatibles en este momento. * Para Ruby, la compatibilidad de la inyección de bibliotecas está en fase Beta. La instrumentación sólo es compatible con Ruby en aplicaciones Rails con una versión de empaquetador superior a 2.3 y sin gemas vendidas (modo de despliegue o `BUNDLE_PATH`). @@ -424,7 +424,7 @@ El valor de `version` es siempre `1`. Esto hace referencia a la versión del esq La siguiente tabla muestra cómo los valores de configuración de la inyección se asignan a las correspondientes [opciones de configuración de bibliotecas de rastreo][4]: -| Inyección | Rastreador Java | Rastreador NodeJS | Rastreador .NET | Rastreador Python | +| Inyección | Rastreador Java | Rastreador Node.js | Rastreador .NET | Rastreador Python | | --------- | ----------- | ------------- | ----------- | ------------- | | `tracing_enabled` | `dd.trace.enabled` | `DD_TRACE_ENABLED` | `DD_TRACE_ENABLED` | `DD_TRACE_ENABLED` | | `log_injection_enabled` | `dd.logs.injection` | `DD_LOGS_INJECTION` | `DD_LOGS_INJECTION` | `DD_LOGS_INJECTION` | @@ -625,7 +625,7 @@ tracing_log_level: debug La siguiente tabla muestra cómo los valores de configuración de la inyección se asignan a las correspondientes [opciones de configuración de bibliotecas de rastreo][4]: -| Inyección | Rastreador Java | Rastreador NodeJS | Rastreador .NET | Rastreador Python | +| Inyección | Rastreador Java | Rastreador Node.js | Rastreador .NET | Rastreador Python | | --------- | ----------- | ------------- | ----------- | ------------- | | `tracing_enabled` | `dd.trace.enabled` | `DD_TRACE_ENABLED` | `DD_TRACE_ENABLED` | `DD_TRACE_ENABLED` | | `log_injection_enabled` | `dd.logs.injection` | `DD_LOGS_INJECTION` | `DD_LOGS_INJECTION` | `DD_LOGS_INJECTION` | @@ -814,7 +814,7 @@ En este archivo de configuración, el valor de `version` es siempre `1`. Esto ha La siguiente tabla muestra cómo los valores de configuración de la inyección se asignan a las correspondientes [opciones de configuración de bibliotecas de rastreo][4]: -| Inyección | Rastreador Java | Rastreador NodeJS | Rastreador .NET | Rastreador Python | +| Inyección | Rastreador Java | Rastreador Node.js | Rastreador .NET | Rastreador Python | | --------- | ----------- | ------------- | ----------- | ------------- | | `tracing_enabled` | `dd.trace.enabled` | `DD_TRACE_ENABLED` | `DD_TRACE_ENABLED` | `DD_TRACE_ENABLED` | | `log_injection_enabled` | `dd.logs.injection` | `DD_LOGS_INJECTION` | `DD_LOGS_INJECTION` | `DD_LOGS_INJECTION` | diff --git a/content/es/universal_service_monitoring/setup.md b/content/es/universal_service_monitoring/setup.md index 3cc2ed54662e9..afad7ed8986b2 100644 --- a/content/es/universal_service_monitoring/setup.md +++ b/content/es/universal_service_monitoring/setup.md @@ -814,10 +814,10 @@ agents: {{< /tabs >}} {{< /collapse-content >}} -{{< collapse-content title="Monitorización de NodeJS TLS" level="h4" >}} +{{< collapse-content title="Monitorización de Node.js TLS" level="h4" >}}
-Universal Service Monitoring está disponible en fase beta para monitorizar solicitudes HTTP, HTTP/2 y gRPC de servicios implementados en NodeJS. +Universal Service Monitoring está disponible en fase beta para monitorizar solicitudes HTTP, HTTP/2 y gRPC de servicios implementados en Node.js.
Requiere Agent versión 7.54 o posterior. diff --git a/content/fr/developers/community/libraries.md b/content/fr/developers/community/libraries.md index df5a12457f087..c432e8edf2a81 100644 --- a/content/fr/developers/community/libraries.md +++ b/content/fr/developers/community/libraries.md @@ -85,7 +85,7 @@ Il s'agit d'une application [ESL de FreeSwitch][30] (rédigée par [WiMacTel][31 Heroku émet des métriques dyno par l'intermédiaire de logs. Pour convertir ces logs en métriques et les envoyer à Datadog, utilisez l'un des drains de log suivants. Pour envoyer vos logs Heroku à Datadog, consultez la section [Recueillir des logs Heroku][34]. -* [Drain de logs Heroku pour Datadog][35] écrit en NodeJS par [Oz][36]. +* [Drain de logs Heroku pour Datadog][35] écrit en Node.js par [Oz][36]. * [Drain de logs Heroku pour Datadog][37] écrit en Go par [Apiary][38]. Pour utiliser le profileur ou traceur PHP dans Heroku, servez-vous du buildpack suivant. diff --git a/content/fr/integrations/mainstorconcept_ziris.md b/content/fr/integrations/mainstorconcept_ziris.md index b2136aac6d104..31c5d5a9e1849 100644 --- a/content/fr/integrations/mainstorconcept_ziris.md +++ b/content/fr/integrations/mainstorconcept_ziris.md @@ -235,7 +235,7 @@ Vous trouverez ci-dessous une liste complète de tous les tags créés avec z/IR | zos.cics.connection.type | Type de connexion CICS | | zos.cics.ipconn_name | Nom de l'ipconn CICS | | zos.cics.net.peer.name | CICS net peer name | -| zos.cics.nodejs_application_name | Nom de l'application CICS NodeJS | +| zos.cics.nodejs_application_name | Nom de l'application CICS Node.js | | zos.cics.pipeline_name | Nom du pipeline CICS | | zos.cics.region_name | Nom de la région CICS | | zos.cics.session.id | ID de la session CICS | diff --git a/content/fr/integrations/node.md b/content/fr/integrations/node.md index e87ab285d429a..1782262cc8647 100644 --- a/content/fr/integrations/node.md +++ b/content/fr/integrations/node.md @@ -20,13 +20,13 @@ further_reading: git_integration_title: node has_logo: true integration_id: node -integration_title: NodeJS +integration_title: Node.js integration_version: '' is_public: true custom_kind: integration manifest_version: '1.0' name: node -public_title: Intégration Datadog/NodeJS +public_title: Intégration Datadog/Node.js short_description: Envoyez des métriques custom à partir de vos services Node.js via DogStatsD ou notre API. version: '1.0' diff --git a/content/fr/logs/log_collection/nodejs.md b/content/fr/logs/log_collection/nodejs.md index 81a2d3c686639..c1676911393ac 100644 --- a/content/fr/logs/log_collection/nodejs.md +++ b/content/fr/logs/log_collection/nodejs.md @@ -20,7 +20,7 @@ further_reading: - link: /glossary/#tail tag: Glossaire text: Entrée du glossaire pour le terme « tail » -title: Collecte de logs avec NodeJS +title: Collecte de logs avec Node.js --- diff --git a/content/fr/security/application_security/threats/add-user-info.md b/content/fr/security/application_security/threats/add-user-info.md index 119e02d788339..e8655da4e6b46 100644 --- a/content/fr/security/application_security/threats/add-user-info.md +++ b/content/fr/security/application_security/threats/add-user-info.md @@ -584,7 +584,7 @@ Les exemples suivants montrent comment surveiller les événements de connexion {{< /programming-lang >}} {{< programming-lang lang="nodejs" >}} -Depuis la version 3.13.1 de dd-trace-js, l'API du traceur NodeJS permet de surveiller les événements utilisateur. +Depuis la version 3.13.1 de dd-trace-js, l'API du traceur Node.js permet de surveiller les événements utilisateur. Les exemples suivants montrent comment surveiller les événements de connexion ou des événements personnalisés (comme ici, les inscriptions). diff --git a/content/fr/serverless/libraries_integrations/plugin.md b/content/fr/serverless/libraries_integrations/plugin.md index 414c06f2ad106..5d8decd8d1ac2 100644 --- a/content/fr/serverless/libraries_integrations/plugin.md +++ b/content/fr/serverless/libraries_integrations/plugin.md @@ -61,14 +61,14 @@ Pour configurer plus d'options pour votre plug-in, utilisez les paramètres pers | `failOnError` | Si ce paramètre est défini, le plug-in renverra une erreur en cas d'échec lors de la création ou de la mise à jour d'un monitor Datadog personnalisé. L'erreur est générée après le déploiement mais entraîne le renvoi d'un code de sortie différent de zéro après l'opération `serverless deploy` (pour faire échouer le CI utilisateur). Valeur par défaut : `false`. | | `logLevel` | Le niveau de log. Définir sur `DEBUG` pour une journalisation étendue. | | `skipCloudformationOutputs` | Définissez ce paramètre sur `true` si vous ne souhaitez pas que les sorties CloudFormation Datadog soient ajoutées pour votre stack. Ce paramètre s'avère utile si vous dépassez la limite de 200 sorties, ce qui peut empêcher la création de votre stack. | -| `enableColdStartTracing` | Définissez ce paramètre sur `false` pour désactiver le tracing des démarrages à froid. Pris en charge avec NodeJS et Python. Valeur par défaut : `true`. | +| `enableColdStartTracing` | Définissez ce paramètre sur `false` pour désactiver le tracing des démarrages à froid. Pris en charge avec Node.js et Python. Valeur par défaut : `true`. | | `coldStartTraceMinDuration` | Permet de définir la durée minimale (en millisecondes) pendant laquelle un événement de chargement de module doit être tracé via le tracing des démarrages à froid. Nombre. Valeur par défaut : `3`. | | `coldStartTraceSkipLibs` | (Facultatif) Permet d'empêcher la création de spans de démarrage à froid pour une liste de bibliothèques séparées par des virgules. Utile pour limiter la profondeur ou ignorer les bibliothèques connues. La valeur par défaut dépend du runtime. | | `subdomain` | Permet de définir un sous-domaine à utiliser pour les URL d'application écrites dans le fichier de sortie. Valeur par défaut : `app`. | -| `enableProfiling` | Définir sur `true` pour activer le profileur en continu Datadog. En version bêta pour NodeJS et Python. Valeur par défaut : `false`. | -| `encodeAuthorizerContext` | Si ce paramètre est défini sur `true` pour des mécanismes d'autorisation Lambda, le contexte de tracing sera encodé dans la réponse en vue de sa propagation. Pris en charge avec NodeJS et Python. Valeur par défaut : `true`. | -| `decodeAuthorizerContext` | Si ce paramètre est défini sur `true` pour les Lambdas autorisées via des mécanismes d'autorisation Lambda, le contexte de tracing sera parsé et utilisé (s'il est détecté). Pris en charge avec NodeJS et Python. Valeur par défaut : `true`. | -| `apmFlushDeadline` | Permet de déterminer à quel moment les spans doivent être envoyées avant qu'un timeout ne se produise, en millisecondes. Lorsque le temps restant dans un appel AWS Lambda est inférieur à la valeur définie, le traceur tente d'envoyer les spans actives actuelles et toutes les spans terminées. Pris en charge avec NodeJS et Python. Valeur par défaut : `100` millisecondes. | +| `enableProfiling` | Définir sur `true` pour activer le profileur en continu Datadog. En version bêta pour Node.js et Python. Valeur par défaut : `false`. | +| `encodeAuthorizerContext` | Si ce paramètre est défini sur `true` pour des mécanismes d'autorisation Lambda, le contexte de tracing sera encodé dans la réponse en vue de sa propagation. Pris en charge avec Node.js et Python. Valeur par défaut : `true`. | +| `decodeAuthorizerContext` | Si ce paramètre est défini sur `true` pour les Lambdas autorisées via des mécanismes d'autorisation Lambda, le contexte de tracing sera parsé et utilisé (s'il est détecté). Pris en charge avec Node.js et Python. Valeur par défaut : `true`. | +| `apmFlushDeadline` | Permet de déterminer à quel moment les spans doivent être envoyées avant qu'un timeout ne se produise, en millisecondes. Lorsque le temps restant dans un appel AWS Lambda est inférieur à la valeur définie, le traceur tente d'envoyer les spans actives actuelles et toutes les spans terminées. Pris en charge avec Node.js et Python. Valeur par défaut : `100` millisecondes. | Pour utiliser l'un de ces paramètres, ajoutez une section `custom` > `datadog` dans votre fichier `serverless.yml` semblable à l'exemple ci-dessous : diff --git a/content/fr/tests/code_coverage.md b/content/fr/tests/code_coverage.md index 78eaffb9ae7b0..c5399a06e1e21 100644 --- a/content/fr/tests/code_coverage.md +++ b/content/fr/tests/code_coverage.md @@ -114,7 +114,7 @@ La couverture de code intégrée au traceur Datadog prend en charge les options | ExcludeByFile | Exclut de la couverture du code des fichiers source spécifiques. | | Exclude | Exclue des éléments de l'analyse de la couverture du code à l'aide d'expressions de filtre. | -##### NodeJS +##### Node.js Vous pouvez exclure une méthode, une classe entière ou un assemblage de la couverture du code en créant et en appliquant l'attribut `ExcludeFromCodeCoverage` au sein de l'espace de nommage `System.Diagnostics.CodeAnalysis`. diff --git a/content/fr/tracing/guide/agent-5-tracing-setup.md b/content/fr/tracing/guide/agent-5-tracing-setup.md index 0e2025320bc43..85621840e1fa7 100644 --- a/content/fr/tracing/guide/agent-5-tracing-setup.md +++ b/content/fr/tracing/guide/agent-5-tracing-setup.md @@ -40,7 +40,7 @@ Pour obtenir davantage d'informations, consultez [la page Docker][7]. {{< nextlink href="tracing/setup/python" tag="Python" >}}Instrumentation avec Python{{< /nextlink >}} {{< nextlink href="tracing/setup/ruby" tag="Ruby" >}}Instrumentation avec Ruby{{< /nextlink >}} {{< nextlink href="tracing/setup/go" tag="Go" >}}Instrumentation avec Go{{< /nextlink >}} - {{< nextlink href="tracing/setup/nodejs" tag="Nodejs" >}}Instrumentation avec Node.js{{< /nextlink >}} + {{< nextlink href="tracing/setup/nodejs" tag="Node.js" >}}Instrumentation avec Node.js{{< /nextlink >}} {{< nextlink href="tracing/setup/dotnet" tag=".NET" >}}Instrumentation avec .NET{{< /nextlink >}} {{< nextlink href="tracing/setup/php" tag="PHP" >}}Instrumentation avec PHP{{< /nextlink >}} {{< /whatsnext >}} diff --git a/content/fr/tracing/guide/inferred-service-opt-in.md b/content/fr/tracing/guide/inferred-service-opt-in.md index 93d3681c66fe3..e497251a1f5df 100644 --- a/content/fr/tracing/guide/inferred-service-opt-in.md +++ b/content/fr/tracing/guide/inferred-service-opt-in.md @@ -27,7 +27,7 @@ Datadog peut automatiquement identifier les dépendances d'un service instrument Datadog utilise les attributs des spans pour déterminer les noms et types des services déduits. Les API externes déduites utilisent par défaut le schéma d'attribution de nom `net.peer.name` (`api.stripe.com`, `api.twilio.com` ou `us6.api.mailchimp.com`, par exemple). Les bases de données déduites utilisent le schéma d'attribution de nom par défaut, c'est-à-dire `db.instance`. -Si vous utilisez le traceur Go, Java, NodeJS, PHP, .NET ou Ruby, vous pouvez personnaliser le nom par défaut des services déduits. Pour en savoir plus, consultez la section « Mappage de services homologues » ci-dessous dans votre langage. +Si vous utilisez le traceur Go, Java, Node.js, PHP, .NET ou Ruby, vous pouvez personnaliser le nom par défaut des services déduits. Pour en savoir plus, consultez la section « Mappage de services homologues » ci-dessous dans votre langage. **Remarque :** si vous configurez des monitors, des dashboards ou des notebooks pour un service déduit spécifique pendant la bêta, vous devrez peut-être les mettre à jour en cas de modification du schéma d'attribution de nom. @@ -133,9 +133,9 @@ DD_TRACE_PEER_SERVICE_MAPPING=10.0.32.3:my-service {{% /tab %}} -{{% tab "NodeJS" %}} +{{% tab "Node.js" %}} -La version minimale requise du traceur NodeJS est la [2.44.0][1], la [3.31.0][2] ou la [4.10.0][3]. Nous vous recommandons d'effectuer régulièrement une mise à niveau vers la dernière version pour bénéficier des nouveautés et des corrections de bugs. +La version minimale requise du traceur Node.js est la [2.44.0][1], la [3.31.0][2] ou la [4.10.0][3]. Nous vous recommandons d'effectuer régulièrement une mise à niveau vers la dernière version pour bénéficier des nouveautés et des corrections de bugs. Pour activer la carte des dépendances, ajoutez les variables d'environnement ou propriétés système suivantes aux paramètres de votre traceur : diff --git a/content/fr/tracing/trace_collection/library_injection_local.md b/content/fr/tracing/trace_collection/library_injection_local.md index 95a12b75b001a..342b6217e6598 100644 --- a/content/fr/tracing/trace_collection/library_injection_local.md +++ b/content/fr/tracing/trace_collection/library_injection_local.md @@ -28,7 +28,7 @@ Pour en savoir plus sur le contrôleur d'admission Kubernetes, consultez la [ré ## Prérequis * Kubernetes v1.14+ -* [Agent de cluster Datadog v7.40+][3] pour Java, Python, NodeJS ; [Agent de cluster Datadog v7.44+][3] pour .NET et Ruby +* [Agent de cluster Datadog v7.40+][3] pour Java, Python, Node.js ; [Agent de cluster Datadog v7.44+][3] pour .NET et Ruby * Activation du contrôleur d'admission Datadog. **Remarque** : depuis la version 2.35.0 du chart Helm, le contrôleur d'admission Datadog est activé par défaut dans l'Agent de cluster. * Pour Python, les applications uWSGI ne sont actuellement pas prises en charge. * Pour Ruby, l'injection de bibliothèque est disponible en bêta. L'instrumentation fonctionne uniquement pour les applications Ruby on Rails avec une version de Bundler ultérieure à la v2.3 et sans gems fournis (mode déploiement ou `BUNDLE_PATH`). @@ -475,7 +475,7 @@ Si plusieurs langages sont utilisés, ne définissez pas `service_language`. Le tableau suivant répertorie les valeurs de configuration d'injection et les [options de configuration des bibliothèques de tracing][4] correspondantes : -| Injection | Traceur Java | Traceur NodeJS | Tracer .NET | Traceur Python | +| Injection | Traceur Java | Traceur Node.js | Tracer .NET | Traceur Python | | --------- | ----------- | ------------- | ----------- | ------------- | | `tracing_enabled` | `dd.trace.enabled` | `DD_TRACE_ENABLED` | `DD_TRACE_ENABLED` | `DD_TRACE_ENABLED` | | `log_injection_enabled` | `dd.logs.injection` | `DD_LOGS_INJECTION` | `DD_LOGS_INJECTION` | `DD_LOGS_INJECTION` | @@ -728,7 +728,7 @@ Dans ce fichier de configuration, `version` a toujours pour valeur `1`. Il s'agi Le tableau suivant répertorie les valeurs de configuration d'injection et les [options de configuration des bibliothèques de tracing][4] correspondantes : -| Injection | Traceur Java | Traceur NodeJS | Tracer .NET | Traceur Python | +| Injection | Traceur Java | Traceur Node.js | Tracer .NET | Traceur Python | | --------- | ----------- | ------------- | ----------- | ------------- | | `tracing_enabled` | `dd.trace.enabled` | `DD_TRACE_ENABLED` | `DD_TRACE_ENABLED` | `DD_TRACE_ENABLED` | | `log_injection_enabled` | `dd.logs.injection` | `DD_LOGS_INJECTION` | `DD_LOGS_INJECTION` | `DD_LOGS_INJECTION` | @@ -926,7 +926,7 @@ Dans ce fichier de configuration, `version` a toujours pour valeur `1`. Il s'agi Le tableau suivant répertorie les valeurs de configuration d'injection et les [options de configuration des bibliothèques de tracing][3] correspondantes : -| Injection | Traceur Java | Traceur NodeJS | Tracer .NET | Traceur Python | +| Injection | Traceur Java | Traceur Node.js | Tracer .NET | Traceur Python | | --------- | ----------- | ------------- | ----------- | ------------- | | `tracing_enabled` | `dd.trace.enabled` | `DD_TRACE_ENABLED` | `DD_TRACE_ENABLED` | `DD_TRACE_ENABLED` | | `log_injection_enabled` | `dd.logs.injection` | `DD_LOGS_INJECTION` | `DD_LOGS_INJECTION` | `DD_LOGS_INJECTION` | diff --git a/content/fr/tracing/troubleshooting/tracer_startup_logs.md b/content/fr/tracing/troubleshooting/tracer_startup_logs.md index 9ba9e931e4285..809dbcdb4943d 100644 --- a/content/fr/tracing/troubleshooting/tracer_startup_logs.md +++ b/content/fr/tracing/troubleshooting/tracer_startup_logs.md @@ -184,7 +184,7 @@ DATADOG TRACER CONFIGURATION - {"date":"2020-07-02T18:51:18.294Z","os_name":"Dar **Diagnostic :** -Le traceur NodeJS génère une ligne de diagnostic lorsque l'Agent n'est pas disponible. +Le traceur Node.js génère une ligne de diagnostic lorsque l'Agent n'est pas disponible. ```text DATADOG TRACER DIAGNOSTIC - Agent Error: Network error trying to reach the agent: connect ECONNREFUSED 127.0.0.1:8126 diff --git a/content/ja/developers/community/libraries.md b/content/ja/developers/community/libraries.md index 78d9b51c9d0b8..2fbc0c18ef9e5 100644 --- a/content/ja/developers/community/libraries.md +++ b/content/ja/developers/community/libraries.md @@ -85,7 +85,7 @@ Enclave は Datadog アカウントにメトリクスを送信します。方法 Heroku は、dyno メトリクスをログから生成します。ログをメトリクスに変換して Datdog に送信するために、以下のログドレインのいずれかを使用します。Heroku のログの Datadog への送信方法については、[Heroku ログの収集][34]を参照してください。 -* [Oz][36] による Nodejs 版 [Heroku Datadog ログドレイン][35] +* [Oz][36] による Node.js 版 [Heroku Datadog ログドレイン][35] * [Apiary][38] による Go 版 [Heroku Datadog ログドレイン][37] Heroku で PHP トレーサーやプロファイラーを使用するには、以下のビルドパックを使用します。 diff --git a/content/ja/developers/dogstatsd/_index.md b/content/ja/developers/dogstatsd/_index.md index b762648419b52..74e5060e02c96 100644 --- a/content/ja/developers/dogstatsd/_index.md +++ b/content/ja/developers/dogstatsd/_index.md @@ -9,7 +9,7 @@ description: データタイプ、タグ付けなど、DogStatsD の機能の概 further_reading: - link: integrations/node tag: ドキュメント - text: NodeJS インテグレーションを利用して NodeJS 用の DogStatsD を有効にします + text: Node.js インテグレーションを利用して Node.js 用の DogStatsD を有効にします - link: developers/dogstatsd tag: ドキュメント text: DogStatsD 入門 diff --git a/content/ja/integrations/guide/source-code-integration.md b/content/ja/integrations/guide/source-code-integration.md index 9d67c84b91586..91b31758c861a 100644 --- a/content/ja/integrations/guide/source-code-integration.md +++ b/content/ja/integrations/guide/source-code-integration.md @@ -216,9 +216,9 @@ Docker コンテナを使用しえいる場合、Docker を使用する、Micros {{% sci-dd-git-env-variables %}} {{% /tab %}} -{{% tab "NodeJS" %}} +{{% tab "Node.js" %}} -
NodeJS クライアントライブラリのバージョン 3.21.0 以降が必要です。
+
Node.js クライアントライブラリのバージョン 3.21.0 以降が必要です。
#### コンテナ diff --git a/content/ja/integrations/node.md b/content/ja/integrations/node.md index 2116b98f53928..b1b6d8351c59a 100644 --- a/content/ja/integrations/node.md +++ b/content/ja/integrations/node.md @@ -20,12 +20,12 @@ further_reading: git_integration_title: node has_logo: true integration_id: node -integration_title: NodeJS +integration_title: Node.js integration_version: '' is_public: true manifest_version: '1.0' name: node -public_title: Datadog-NodeJS インテグレーション +public_title: Datadog-Node.js インテグレーション short_description: Node.js サービスから DogStatsD または Datadog API 経由でカスタムメトリクスを送信。 version: '1.0' --- diff --git a/content/ja/logs/log_configuration/attributes_naming_convention.md b/content/ja/logs/log_configuration/attributes_naming_convention.md index f90e3fcd583f7..2926444c39a8a 100644 --- a/content/ja/logs/log_configuration/attributes_naming_convention.md +++ b/content/ja/logs/log_configuration/attributes_naming_convention.md @@ -94,7 +94,7 @@ title: 属性とエイリアス設定 - URL の詳細に関する属性には、`http.url_details` というプレフィックスが付きます。これらの属性は、HTTP URL のパースされた各部に関する詳細を提供します。[URL パーサー][14]によって生成されます。 - [ソースコード][15] - カスタムアプリケーションのロガーを使用してログまたはエラーを生成する際に使用されるデータに関係する属性です。すべての属性に `logger` または `error` というプレフィックスが付けられています。 - - これらの属性に依存する代表的なインテグレーションには、Java、NodeJs、.NET、Golang、Python などがあります。 + - これらの属性に依存する代表的なインテグレーションには、Java、Node.js、.NET、Golang、Python などがあります。 - [データベース][16] - これらの属性に依存する代表的なインテグレーションには、[Cassandra][17]、[MySQL][18]、[RDS][19]、[Elasticsearch][20] などがあります。 - [パフォーマンス][21] diff --git a/content/ja/security/application_security/threats/add-user-info.md b/content/ja/security/application_security/threats/add-user-info.md index 697dc3627cfce..a010433c0ebbe 100644 --- a/content/ja/security/application_security/threats/add-user-info.md +++ b/content/ja/security/application_security/threats/add-user-info.md @@ -593,7 +593,7 @@ dd-trace-php v0.84.0 からは、PHP トレーサーの API を使用してユ {{< /programming-lang >}} {{< programming-lang lang="nodejs" >}} -dd-trace-js v3.13.1 からは、NodeJS トレーサーの API を使用してユーザーイベントを追跡することができます。 +dd-trace-js v3.13.1 からは、Node.js トレーサーの API を使用してユーザーイベントを追跡することができます。 次の例は、ログインイベントやカスタムイベント (サインアップを例とする) を追跡する方法を示しています。 diff --git a/content/ja/security/application_security/troubleshooting.md b/content/ja/security/application_security/troubleshooting.md index 28e75f72e2784..a2836651ebdac 100644 --- a/content/ja/security/application_security/troubleshooting.md +++ b/content/ja/security/application_security/troubleshooting.md @@ -551,7 +551,7 @@ See the Application Security product set up documentation to validate you you ar ### テレメトリーデータの通信を確保する -環境変数 `DD_INSTRUMENTATION_TELEMETRY_ENABLED` (NodeJS の場合は `DD_TRACE_TELEMETRY_ENABLED`) が `true` に設定されているか、または使用する言語の対応システムプロパティが有効になっていることを確認します。例えば、Java の場合: `-Ddd.instrumentation.telemetry.enabled=true` +環境変数 `DD_INSTRUMENTATION_TELEMETRY_ENABLED` (Node.js の場合は `DD_TRACE_TELEMETRY_ENABLED`) が `true` に設定されているか、または使用する言語の対応システムプロパティが有効になっていることを確認します。例えば、Java の場合: `-Ddd.instrumentation.telemetry.enabled=true` ## 脅威管理と保護を無効にする diff --git a/content/ja/serverless/guide/serverless_tracing_and_bundlers.md b/content/ja/serverless/guide/serverless_tracing_and_bundlers.md index 72a6d8a8eba7d..14007c59e5808 100644 --- a/content/ja/serverless/guide/serverless_tracing_and_bundlers.md +++ b/content/ja/serverless/guide/serverless_tracing_and_bundlers.md @@ -156,7 +156,7 @@ If you deploy Node.js Lambda functions using the `NodeJsFunction` construct, but return [] } }, - externalModules: ['@aws-sdk/client-dynamodb'] // The AWS SDK is included as part of the NodeJS Lambda runtime + externalModules: ['@aws-sdk/client-dynamodb'] // The AWS SDK is included as part of the Node.js Lambda runtime } }); ``` diff --git a/content/ja/serverless/libraries_integrations/cli.md b/content/ja/serverless/libraries_integrations/cli.md index 17157780cfc71..00c6c8eb4e96a 100644 --- a/content/ja/serverless/libraries_integrations/cli.md +++ b/content/ja/serverless/libraries_integrations/cli.md @@ -113,7 +113,7 @@ See the configuration section for additional settings. | `--no-source-code-integration` | | Datadog ソースコードインテグレーションを無効にします。 | | | `--upload-git-metadata` | `-u` | ソースコードインテグレーションの一部として、Git メタデータのアップロードを有効にするかどうか。Git メタデータのアップロードは、Datadog Github インテグレーションをインストールしていない場合のみ必要です。 | `true` | | `--no-upload-git-metadata` | | ソースコードインテグレーションの一部として、Git メタデータのアップロードを無効にします。Datadog Github インテグレーションをインストールしている場合、このフラグを使用すると、Git メタデータのアップロードが不要になります。 | | -| `--apm-flush-deadline` | | タイムアウトが発生する前にスパンを送信するタイミングをミリ秒単位で決定するために使用されます。AWS Lambda の呼び出しの残り時間が設定された値よりも小さい場合、トレーサーは、現在のアクティブなスパンとすべての終了したスパンの送信を試みます。NodeJS と Python でサポートされています。デフォルトは `100` ミリ秒です。 | | +| `--apm-flush-deadline` | | タイムアウトが発生する前にスパンを送信するタイミングをミリ秒単位で決定するために使用されます。AWS Lambda の呼び出しの残り時間が設定された値よりも小さい場合、トレーサーは、現在のアクティブなスパンとすべての終了したスパンの送信を試みます。Node.js と Python でサポートされています。デフォルトは `100` ミリ秒です。 | |
#### `uninstrument` diff --git a/content/ja/serverless/libraries_integrations/macro.md b/content/ja/serverless/libraries_integrations/macro.md index 753516dc5c107..771dd5cb6c456 100644 --- a/content/ja/serverless/libraries_integrations/macro.md +++ b/content/ja/serverless/libraries_integrations/macro.md @@ -139,13 +139,13 @@ aws cloudformation update-stack \ | `tags` | 1 つの文字列としての key:value のペアのカンマ区切りのリスト。`extensionLayerVersion` と共に設定すると、すべての Lambda 関数に `DD_TAGS` 環境変数が追加され、指定した値が設定されます。`forwarderArn` と共に指定すると、マクロは文字列をパースして、各 key:value ペアをタグとしてすべての Lambda 関数に設定します。 | | `logLevel` | ログのレベルを設定します。拡張ロギングの場合 `DEBUG` に設定します。 | | `captureLambdaPayload` | 関数の実行スパンにリクエストと応答のペイロードを自動的にタグ付けして、APM アプリケーションに表示できるようにします。 | -| `enableColdStartTracing` | コールドスタートトレースを無効にするには、`false` に設定します。NodeJS と Python で使用されます。デフォルトは `true` です。 | +| `enableColdStartTracing` | コールドスタートトレースを無効にするには、`false` に設定します。Node.js と Python で使用されます。デフォルトは `true` です。 | | `coldStartTraceMinDuration` | コールドスタートトレースでトレースするモジュールロードイベントの最小継続時間 (ミリ秒) を設定します。数値。デフォルトは `3` です。 | | `coldStartTraceSkipLibs` | オプションで、カンマで区切られたライブラリのリストに対してコールドスタートスパンの作成をスキップすることができます。深さを制限したり、既知のライブラリをスキップするのに便利です。デフォルトはランタイムに依存します。 | -| `enableProfiling` | Datadog Continuous Profiler を `true` で有効にします。NodeJS と Python のベータ版でサポートされています。デフォルトは `false` です。 | -| `encodeAuthorizerContext` | Lambda オーサライザーで `true` に設定すると、トレースコンテキストがレスポンスにエンコードされて伝搬されます。NodeJS と Python でサポートされています。デフォルトは `true` です。 | -| `decodeAuthorizerContext` | Lambda オーサライザーで認可された Lambda に対して `true` を設定すると、エンコードされたトレースコンテキストをパースして使用します (見つかった場合)。NodeJS と Python でサポートされています。デフォルトは `true` です。 | -| `apmFlushDeadline` | タイムアウトが発生する前にスパンを送信するタイミングをミリ秒単位で決定するために使用されます。AWS Lambda の呼び出しの残り時間が設定された値よりも小さい場合、トレーサーは、現在のアクティブなスパンとすべての終了したスパンの送信を試みます。NodeJS と Python でサポートされています。デフォルトは `100` ミリ秒です。 | +| `enableProfiling` | Datadog Continuous Profiler を `true` で有効にします。Node.js と Python のベータ版でサポートされています。デフォルトは `false` です。 | +| `encodeAuthorizerContext` | Lambda オーサライザーで `true` に設定すると、トレースコンテキストがレスポンスにエンコードされて伝搬されます。Node.js と Python でサポートされています。デフォルトは `true` です。 | +| `decodeAuthorizerContext` | Lambda オーサライザーで認可された Lambda に対して `true` を設定すると、エンコードされたトレースコンテキストをパースして使用します (見つかった場合)。Node.js と Python でサポートされています。デフォルトは `true` です。 | +| `apmFlushDeadline` | タイムアウトが発生する前にスパンを送信するタイミングをミリ秒単位で決定するために使用されます。AWS Lambda の呼び出しの残り時間が設定された値よりも小さい場合、トレーサーは、現在のアクティブなスパンとすべての終了したスパンの送信を試みます。Node.js と Python でサポートされています。デフォルトは `100` ミリ秒です。 | ## 仕組み diff --git a/content/ja/serverless/libraries_integrations/plugin.md b/content/ja/serverless/libraries_integrations/plugin.md index b0cb0cf4df653..3331797210264 100644 --- a/content/ja/serverless/libraries_integrations/plugin.md +++ b/content/ja/serverless/libraries_integrations/plugin.md @@ -62,14 +62,14 @@ Datadog は、サーバーレスフレームワークを使用してサーバー | `failOnError` | When set, this plugin throws an error if any custom Datadog monitors fail to create or update. This occurs after deploy, but will cause the result of `serverless deploy` to return a nonzero exit code (to fail user CI). Defaults to `false`. | | `logLevel` | ログのレベル。拡張ロギングの場合 `DEBUG` に設定します。 | | `skipCloudformationOutputs` | スタックに Datadog Cloudformation Outputs を追加するのをスキップしたい場合は、`true` に設定します。これは、スタックの作成に失敗する原因となる 200 の出力制限に遭遇している場合に有効です。 | -| `enableColdStartTracing` | コールドスタートトレースを無効にするには、`false` に設定します。NodeJS と Python で使用されます。デフォルトは `true` です。 | +| `enableColdStartTracing` | コールドスタートトレースを無効にするには、`false` に設定します。Node.js と Python で使用されます。デフォルトは `true` です。 | | `coldStartTraceMinDuration` | コールドスタートトレースでトレースするモジュールロードイベントの最小継続時間 (ミリ秒) を設定します。数値。デフォルトは `3` です。 | | `coldStartTraceSkipLibs` | オプションで、カンマで区切られたライブラリのリストに対してコールドスタートスパンの作成をスキップすることができます。深さを制限したり、既知のライブラリをスキップするのに便利です。デフォルトはランタイムに依存します。 | | `subdomain` | 出力されるアプリの URL に使用するオプションのサブドメインを設定します。デフォルトは `app` です。 | -| `enableProfiling` | Datadog Continuous Profiler を `true` で有効にします。NodeJS と Python のベータ版でサポートされています。デフォルトは `false` です。 | -| `encodeAuthorizerContext` | Lambda オーサライザーで `true` に設定すると、トレースコンテキストがレスポンスにエンコードされて伝搬されます。NodeJS と Python でサポートされています。デフォルトは `true` です。 | -| `decodeAuthorizerContext` | Lambda オーサライザーで認可された Lambda に対して `true` を設定すると、エンコードされたトレースコンテキストをパースして使用します (見つかった場合)。NodeJS と Python でサポートされています。デフォルトは `true` です。 | -| `apmFlushDeadline` | タイムアウトが発生する前にスパンを送信するタイミングをミリ秒単位で決定するために使用されます。AWS Lambda の呼び出しの残り時間が設定された値よりも小さい場合、トレーサーは、現在のアクティブなスパンとすべての終了したスパンの送信を試みます。NodeJS と Python でサポートされています。デフォルトは `100` ミリ秒です。 | +| `enableProfiling` | Datadog Continuous Profiler を `true` で有効にします。Node.js と Python のベータ版でサポートされています。デフォルトは `false` です。 | +| `encodeAuthorizerContext` | Lambda オーサライザーで `true` に設定すると、トレースコンテキストがレスポンスにエンコードされて伝搬されます。Node.js と Python でサポートされています。デフォルトは `true` です。 | +| `decodeAuthorizerContext` | Lambda オーサライザーで認可された Lambda に対して `true` を設定すると、エンコードされたトレースコンテキストをパースして使用します (見つかった場合)。Node.js と Python でサポートされています。デフォルトは `true` です。 | +| `apmFlushDeadline` | タイムアウトが発生する前にスパンを送信するタイミングをミリ秒単位で決定するために使用されます。AWS Lambda の呼び出しの残り時間が設定された値よりも小さい場合、トレーサーは、現在のアクティブなスパンとすべての終了したスパンの送信を試みます。Node.js と Python でサポートされています。デフォルトは `100` ミリ秒です。 | | `enableStepFunctionsTracing` | Datadog Forwarder の Step Function ロググループと Step Function トレーシングへの自動サブスクリプションを有効にします。Step Function のロググループが構成されていない場合は、自動的に作成されます。`forwarderArn` の設定が必要です。デフォルトは `false` です。 | | `propagateUpstreamTrace` | `true` に設定すると、下流の Stepfunction の起動トレースは上流の Stepfunction の起動とマージされます。デフォルトは `false` です。 | | `redirectHandlers` | オプションで、`false` に設定した場合にハンドラーのリダイレクトを無効にします。これは APM が完全に無効になっている場合にのみ `false` に設定してください。デフォルトは `true` です。 | diff --git a/content/ja/service_management/incident_management/incident_details.md b/content/ja/service_management/incident_management/incident_details.md deleted file mode 100644 index 43c47f4ae98d1..0000000000000 --- a/content/ja/service_management/incident_management/incident_details.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -aliases: -- /ja/monitors/incident_management/incident_details -description: インシデントのコンテキストと作業を管理する -further_reading: -- link: dashboards/querying/#incident-management-analytics - tag: Documentation - text: インシデント管理分析 -title: インシデント詳細ページ ---- - -## 概要 - -{{< img src="/service_management/incidents/incident_details/incident_overview_page.png" alt="Active SEV-4 インシデントのインシデント詳細ページ。" style="width:100%;">}} - -Datadog のすべてのインシデントには、インシデントのプロパティフィールド、シグナル、タスク、ドキュメント、対応者、および通知を管理できる独自の Incident Details ページがあります。Incident Details ページは、[新しいインシデントを作成][1]した後に利用できます。Incident Details ページには、キーアクションに素早くアクセスするためのグローバルヘッダーがあり、残りのページ本体は、関連するインシデントデータをグループ化するためのタブによって、異なるセクションに分かれています。最初のセクションは Overview です。 - -## グローバルヘッダー - -グローバルヘッダーは、[Status and Severity][2] セレクタへのアクセス、および [Incident Integrations][3] へのリンクを提供します。Slack および Microsoft Teams のリンクについて、新しいインシデントごとに自動リンクを構成する方法の詳細については、[インシデントの設定][4]を参照してください。 - -インシデントを解決済みステータスに移動すると、[事後分析テンプレート][5]を使用して事後分析ノートブックを生成するオプションがヘッダーに表示されます。[Incident Settings][6] ページで事後分析テンプレートを構成して、事後分析の構造と内容を事前に定義します。 - -## インシデント詳細の概要セクション - -Overview セクションを使用して、インシデントのプロパティを指定し、顧客への影響を定義します。 - -デフォルトでは、すべてのインシデントには以下のプロパティがあります。 - -* Root Cause -* サービス -* チーム -* 検出方法 -* サマリー - -プロパティは以下の 3 つのセクションに分かれています。 - -* 発生した事象 -* 発生原因 -* 属性 - -[Incident Settings][7] で、Datadog メトリクスタグから `:` ペアを使用してプロパティフィールドを追加するか、カスタムフィールドを作成します。インシデントのプロパティに値を割り当てると、[Incident Homepage][8] でインシデントのサブセットを検索したり、[Incident Management Analytics][9] を使用する際にクエリを形成したりできます。プロパティフィールドを並べ替えたり、異なる見出しに移動させたりして、最も重要なプロパティを目立つ場所に配置することもできます。 - -インシデントが顧客向けの場合は、Impact セクションで詳細を指定します。 - -1. **Add** をクリックします。 -2. 影響の開始日時を指定します。 -3. 影響の終了日時を指定するか、影響が継続中の場合は空白のままにします。 -4. `Scope of impact` に顧客に対する影響の性質を記述します。 -5. **Save** をクリックします。 - -プロパティフィールドの他に、Overview セクションには以下のような一目でわかるサマリーモジュールがあります。 - -1. *Condensed Timeline*: インシデントのライフサイクルの概要を把握できるように、インシデントが状態を変更した時間、影響が開始した時間と終了した時間が表示されます。 -2. *Latest Notifications*: [Notification セクション](#notifications-section)にある通知の全リストに素早くアクセスできるように、インシデントに対して送信された最新の通知が表示されます。 -3. *Pending Tasks*: [Remediation セクション](#remediation-section)にあるタスクの全リストに素早くアクセスできるように、最新の未完了タスクが表示されます。 -4. *Responders*: 現在のインシデントコマンダーと、インシデントに割り当てられている残りの対応者のアバターが表示されます。 -5. *Recent timeline entries*: [Timeline セクション](#timeline-section)全体に素早くアクセスできるように、インシデントタイムラインの最新の 5 つのエントリが表示されます。 - -## Timeline セクション - -{{< img src="/service_management/incidents/incident_details/incident_details_timeline.png" alt="インシデントにエスカレーションされたケースの進行を示すインシデントの詳細の Timeline ビュー" style="width:100%;">}} - -Incident Timeline は、インシデント中に行われた作業の主な情報源です。アクションが実行されると、新しいセルが時系列でタイムラインに追加され、変更内容、変更者、変更時刻がキャプチャされます。 - -### Content types - -各セルには、そのセルに含まれる情報の種類を示す独自のコンテンツタイプがあります。 - -| Content type | 説明 | -| ------------------ | ------------------------------------------------------------------------------------------------------ | -| Responder note | インシデント対応者が手動で書いたメモ。対応者メモには以下のサブタイプがあります。
- *Graph*: 対応者メモに 1 つ以上の Datadog グラフが含まれている
- *Link*: 対応者メモにハイパーリンクが含まれている
- *Code*: 対応者メモにコードブロックの Markdown 構文でラップされたテキストが含まれている -| Incident update | インシデントのプロパティ (ステータスや重大度を含む) やその影響に加えられた変更。 -| Integration update | Incident Management 製品の[インテグレーション][3]を通じて行われた変更。 -| Task | Incident Details ページの Remediation セクションでインシデントタスクに加えられたすべての変更。 -| Notification sent | インシデント対応者から手動通知が送信された場合の更新。 - -Incident Details ページのセクションを切り替えるタブのすぐ下にあるテキストボックスを使って、タイムラインに直接対応者メモを追加します。作成時の対応者メモのタイムスタンプをカスタマイズすることで、タイムラインの時系列で、以前の時点に関連する重要な情報をキャプチャすることができます。自分が作成した対応者メモについては、内容やタイムスタンプを編集したり、メモを完全に削除したりできます。また、特定のセルへのリンクをコピーして、チームメイトと共有することもできます。対応者メモは [Slack からタイムラインに追加][10]することができます。 - -グラフセルに限り、[組織設定][11]で有効化されている場合、グラフの定義はグラフの共有 URL を用いて保存されます。タイムラインにグラフセルを追加すると、ダッシュボード、ノートブック、その他のページに見られる完全なインタラクティブホバー状態を備えています。タイムラインに追加されてから 24 時間後、グラフはグラフが表示していたものをキャプチャした静止イメージに置き換えられます。これにより、短期間保持されるデータを表示するグラフについても、グラフ内のライブデータが失効した後でもバックアップイメージが取得されることを保証します。 - -デフォルトでは、タイムラインのセルは `oldest first` (古い順) にソートされますが、タイムラインの一番上にあるボタンを使って `newest first` (新しい順) に変更することができます。 - -## Remediation セクション - -インシデントの修復プロセスに関連するドキュメントやリソースを保存したり、修復プロセスの主要タスクを追跡するには、Remediation セクションを使用します。 - -ドキュメントを追加するには、ドキュメントの URL を貼り付け、素早くアクセスできるようにリンクに人間が読める名前を付けます。 - -インシデントタスクは、Datadog の [Slack インテグレーション][12]と同様に、Remediation セクションで直接作成することができます。 - -Remediation セクションの creation テキストボックスにタスクの説明を入力します。タスクを Datadog ユーザーに割り当てるには、説明テキストボックスに `@` と入力するか、タスク作成後に `Assignees` 列を使用します。インシデントタスクは複数の担当者を持つことができます。タスクの作成後、期限を割り当てることもできます。 - -異なるタスクの作業が終了すると、タスクの説明の左にあるチェックボックスをクリックすることで、個々のタスクに完了マークを付けることができます。タスクの数が多い場合は、キーワードで検索したり、完了したタスクを非表示にすることで絞り込むことができます。 - -## Response Team セクション - -
-これはオープンベータ版の機能です。 -
- -{{< img src="/service_management/incidents/incident_details/incident_response_team.png" alt="割り当てられたインシデントコマンダー、対応者、コミュニケーションリードを示すインシデント詳細対応チームセクション" style="width:100%;" >}} - -対応チームセクションでは、他のユーザーを追加し、インシデントの解決プロセスで実行するロールを割り当てることで、対応チームを編成することができます。Datadog が提供するデフォルトの対応者タイプは以下の 2 つです。 - -1. `Incident Commander` - 対応チームのリーダーを務める責任者 -3. `Responder` - インシデントの調査やその根本的な問題の解決に積極的に貢献している人 - -カスタムの対応者ロールを作成したい場合は、[Incident Settings の Responder Types][13] で行うことができます。これにより、カスタムの名前と説明で新しい対応者タイプを作成できます。また、対応者タイプが one person role か multi person role かを選択することも可能です。 - -**注:** これらのロールは、[ロールベースのアクセス制御 (RBAC)][14] システムにおけるロールとは無関係です。RBAC のロールは、Datadog の特定の機能に対するユーザーのアクセス許可を制御します。インシデント管理における対応者タイプシステムは、いかなる点においてもユーザーのアクセス許可を変更するものではありません。それよりも、対応者をインシデントに招待し、対応プロセスにおいて文書化されたロールを付与することで可視性を高めることが目的です。 - -個人を対応者として追加すると、その人の Datadog アカウントに関連付けられたメールを通じて通知されます。対応者のロールは誰でも変更できますが、インシデントの対応チームから個人を削除できるのは、その個人が一般的な `Responder` のロールを持ち、インシデントで何の活動も行っていない場合のみです。インシデントにすでに `Incident Commander` が割り当てられている場合、別の個人を `Incident Commander` に指定すると、そのロールはその個人に引き継がれます。以前の `Incident Commander` には `Responder` のロールが再割り当てされます。カスタムの one person role を再割り当てした場合も、必ず同様の再割り当てが発生します。 - -対応チームリストには、個人が最初にインシデントの対応チームに追加された日付と時間、およびその個人がインシデントタイムラインに最後に何かを投稿した日付と時間も保存されます。 - -## 通知セクション - -{{< img src="service_management/incidents/incident_notifications.jpeg" alt="インシデント通知" style="width:80%;">}} - -インシデントに対するすべてのステークホルダーからの通知は、通知セクションに集約されます。 -このページから直接、通知を手動で作成、下書きとして保存、送信することができます。当該インシデントの[通知ルール][15]によって送信された自動通知も、このセクションにリストされます。 - -手動で通知を作成するには - -1. セクションの右上にある **+ New Notification** ボタンをクリックします。 -2. 希望する受信者を入力します。メール、Slack チャンネル、PagerDuty ハンドル、Webhook など、Datadog がサポートする通知ハンドルであれば、どれでもかまいません。 -3. [メッセージテンプレート][16]を選択します。 -4. Markdown とサポートされているインシデントテンプレート変数を使用して、必要に応じて通知のタイトルとメッセージを編集し、`{{` と入力します。 - - テンプレート変数は、インシデントのプロパティに基づきます。メッセージが送信される前に、すべてのテンプレート変数は、メッセージが送信されたときに利用可能な参照プロパティの対応する値で置き換えられます。 -5. メッセージのタイムゾーンをカスタマイズするには `{{incident.created}}` 変数を使います。このテンプレート変数はタイムゾーンを設定するオプションを表示します。 -6. 通知を送信するか、下書きとして保存します。 - -通知セクションは、下書きリストと送信済みリストに分かれています。 - -両方のリストに以下が表示されます。 - -1. 通知の (意図された) 受信者 -2. 通知のメッセージの内容、および送信された再通知メッセージ -3. 通知が最後にいつ更新されたか -4. 通知の元の作成者 - -送信済みリストには、通知が通知ルールによって手動で送信されたのか、自動的に送信されたのかも表示されます。通知が自動送信された場合、通知のトリガーとなったルールが表示されます。 - -## はじめに - -[Incident Management 入門][17]ガイドのワークフロー例を実行してください。 - -## その他の参考資料 - -{{< partial name="whats-next/whats-next.html" >}} - -[1]: /ja/service_management/incident_management/#creating-an-incident -[2]: /ja/service_management/incident_management/#describing-the-incident -[3]: /ja/service_management/incident_management/#integrations -[4]: /ja/service_management/incident_management/incident_settings#integrations -[5]: /ja/service_management/incident_management/incident_settings#postmortem-templates -[6]: https://app.datadoghq.com/incidents/settings#Postmortems -[7]: https://app.datadoghq.com/incidents/settings#Property-Fields -[8]: https://app.datadoghq.com/incidents -[9]: /ja/service_management/incident_management/analytics -[10]: /ja/integrations/slack/?tab=slackapplicationus#using-datadog-incidents -[11]: https://app.datadoghq.com/organization-settings/public-sharing/settings -[12]: /ja/integrations/slack/?tab=slackapplicationus#manage-incident-tasks -[13]: /ja/service_management/incident_management/incident_settings/#responder-types -[14]: /ja/account_management/rbac/?tab=datadogapplication -[15]: /ja/service_management/incident_management/incident_settings#rules -[16]: /ja/service_management/incident_management/incident_settings#message-templates -[17]: /ja/getting_started/incident_management \ No newline at end of file diff --git a/content/ja/tracing/guide/agent-5-tracing-setup.md b/content/ja/tracing/guide/agent-5-tracing-setup.md index 5bb71071f4619..7b8724f219265 100644 --- a/content/ja/tracing/guide/agent-5-tracing-setup.md +++ b/content/ja/tracing/guide/agent-5-tracing-setup.md @@ -39,7 +39,7 @@ Docker コンテナでアプリケーションをトレースするには、[doc {{< nextlink href="tracing/setup/python" tag="Python" >}}Python 言語のインスツルメンテーション。{{< /nextlink >}} {{< nextlink href="tracing/setup/ruby" tag="Ruby" >}}Ruby 言語のインスツルメンテーション。{{< /nextlink >}} {{< nextlink href="tracing/setup/go" tag="Go" >}}Go 言語のインスツルメンテーション。{{< /nextlink >}} - {{< nextlink href="tracing/setup/nodejs" tag="Nodejs" >}}Node.js 言語のインスツルメンテーション。{{< /nextlink >}} + {{< nextlink href="tracing/setup/nodejs" tag="Node.js" >}}Node.js 言語のインスツルメンテーション。{{< /nextlink >}} {{< nextlink href="tracing/setup/dotnet" tag=".NET" >}}.NET 言語のインスツルメンテーション。{{< /nextlink >}} {{< nextlink href="tracing/setup/php" tag="PHP" >}}PHP 言語のインスツルメンテーション。{{< /nextlink >}} {{< /whatsnext >}} diff --git a/content/ja/tracing/trace_collection/library_injection_local.md b/content/ja/tracing/trace_collection/library_injection_local.md index 7cc022ffde651..2c6d8a8458283 100644 --- a/content/ja/tracing/trace_collection/library_injection_local.md +++ b/content/ja/tracing/trace_collection/library_injection_local.md @@ -30,7 +30,7 @@ Kubernetes Admission Controller の詳細については、[Kubernetes Admission ## 要件 * Kubernetes v1.14+ -* Java、Python、NodeJS については Datadog [Cluster Agent v7.40+][3]、.NET、Ruby については Datadog [Cluster Agent v7.44+][3]。 +* Java、Python、Node.js については Datadog [Cluster Agent v7.40+][3]、.NET、Ruby については Datadog [Cluster Agent v7.44+][3]。 * Datadog Admission Controller が有効になっている。**注**: Helm chart v2.35.0 以降では、Cluster Agent で Datadog Admission Controller がデフォルトでアクティブになります。 * Python の場合、現時点では uWSGI アプリケーションはサポートされていません。 * Ruby については、ライブラリ挿入のサポートはベータ版です。インスツルメンテーションは、Bundler のバージョンが 2.3 以上で、vendored gems (デプロイモードまたは `BUNDLE_PATH`) がない Ruby on Rails アプリケーションでのみサポートされています。 diff --git a/content/ja/tracing/trace_collection/trace_context_propagation/_index.md b/content/ja/tracing/trace_collection/trace_context_propagation/_index.md index 38e76cd845dff..ff636d037349e 100644 --- a/content/ja/tracing/trace_collection/trace_context_propagation/_index.md +++ b/content/ja/tracing/trace_collection/trace_context_propagation/_index.md @@ -191,11 +191,11 @@ The Datadog Go SDK supports the following trace context formats, including depre {{% /tab %}} -{{% tab "NodeJS" %}} +{{% tab "Node.js" %}} ### Supported formats -The Datadog NodeJS SDK supports the following trace context formats, including deprecated configuration values: +The Datadog Node.js SDK supports the following trace context formats, including deprecated configuration values: | 形式 | Configuration Value | |------------------------|---------------------| diff --git a/content/ko/developers/community/libraries.md b/content/ko/developers/community/libraries.md index 5ca0b62acd26c..1916969d3fb30 100644 --- a/content/ko/developers/community/libraries.md +++ b/content/ko/developers/community/libraries.md @@ -85,7 +85,7 @@ Enclave는 메트릭을 Datadog 계정으로 전달합니다. [자세히 알아 헤로쿠(Heroku)는 로그를 통해 다이노 메트릭을 방출합니다. 이러한 로그를 메트릭으로 변환하여 Datadog으로 전송하려면 다음 로그 드레인 중 하나를 사용합니다.. Datadog으로 헤로쿠(Heroku) 로그를 보내려면, [헤로쿠(Heroku) 로그 수집][34]을 참조하세요. -* [Oz][36]가 NodeJS로 작성한 [헤로쿠(Heroku) Datadog 로그 드레인] [35] +* [Oz][36]가 Node.js로 작성한 [헤로쿠(Heroku) Datadog 로그 드레인] [35] * [Apiary][38]가 Go로 작성한 [헤로쿠(Heroku) Datadog 로그 드레인] [37]. 헤로쿠(Heroku)에서 PHP 트레이서 또는 프로파일러를 사용하려면 다음 빌드팩을 사용하세요. diff --git a/content/ko/developers/dogstatsd/_index.md b/content/ko/developers/dogstatsd/_index.md index c2a302bb9d616..2e887272157ac 100644 --- a/content/ko/developers/dogstatsd/_index.md +++ b/content/ko/developers/dogstatsd/_index.md @@ -9,7 +9,7 @@ description: 데이터 유형 및 태깅을 포함하는 DogStatsD 기능에 대 further_reading: - link: integrations/node tag: 도움말 - text: NodeJS 통합을 통해 NodeJS용 DogStatsD 활성화 + text: Node.js 통합을 통해 Node.js용 DogStatsD 활성화 - link: developers/dogstatsd tag: 도움말 text: DogStatsD 소개 diff --git a/content/ko/integrations/node.md b/content/ko/integrations/node.md index e6087542693fa..99bbeede46413 100644 --- a/content/ko/integrations/node.md +++ b/content/ko/integrations/node.md @@ -20,12 +20,12 @@ further_reading: git_integration_title: node has_logo: true integration_id: node -integration_title: NodeJS +integration_title: Node.js integration_version: '' is_public: true manifest_version: '1.0' name: node -public_title: Datadog-NodeJS Integration +public_title: Datadog-Node.js Integration short_description: DogStatsD 또는 API를 통해 Node.js 서비스에서 커스텀 메트릭 전송 version: '1.0' --- diff --git a/content/ko/logs/log_configuration/attributes_naming_convention.md b/content/ko/logs/log_configuration/attributes_naming_convention.md index 8d67fd98e56ab..2dfbbc9becc94 100644 --- a/content/ko/logs/log_configuration/attributes_naming_convention.md +++ b/content/ko/logs/log_configuration/attributes_naming_convention.md @@ -94,7 +94,7 @@ title: 속성과 별칭 - URL 세부정보 속성 앞에는 `http.url_details`가 붙습니다. 이러한 속성은 HTTP URL의 파싱된 부분에 대한 세부정보를 제공합니다. [URL 파서][14]에 의해 생성됩니다. - [소스 코드][15] - 이러한 속성은 커스텀 애플리케이션의 로거로 인해 로그 또는 오류가 생성될 때 사용되는 데이터와 관련이 있습니다. 모든 속성에는 `logger` 또는 `error` 접두사가 붙습니다. - - 이러한 속성을 사용하는 일반적인 통합에는 Java, NodeJs, .NET, Golang, Python 등이 있습니다. + - 이러한 속성을 사용하는 일반적인 통합에는 Java, Node.js, .NET, Golang, Python 등이 있습니다. - [데이터베이스][16] - 이러한 속성을 사용하는 일반적인 통합은 [Cassandra][17], [MySQL][18], [RDS][19], [Elasticsearch][20] 등입니다. - [성능][21] diff --git a/content/ko/security/application_security/threats/attacker-explorer.md b/content/ko/security/application_security/threats/attacker-explorer.md new file mode 100644 index 0000000000000..e05e825781ae8 --- /dev/null +++ b/content/ko/security/application_security/threats/attacker-explorer.md @@ -0,0 +1,153 @@ +--- +disable_toc: false +further_reading: +- link: /security/application_security/threats/protection + tag: 설명서 + text: 보호 +title: Attacker Explorer +--- + +이 가이드에서는 **Attacker Explorer**를 사용하여 Flagged Attackers를 조사하고 차단하는 방법을 설명합니다. + +## 개요 + +Datadog 애플리케이션 보안 관리(ASM)는 공격자를 의심스러운 것으로 식별하고 플래그를 지정합니다. [Attacker Explorer][1]를 사용하면 공격자를 조사하고 조치를 취할 수 있습니다. + + +### 정의 + +- **Suspicious Attackers:** 지난 24시간 동안 최대 임계값까지 공격 트래픽을 보낸 IP 주소입니다. + +- **Flagged Attackers:** 지난 24시간 동안 Suspicious Attackers 임계값을 초과하는 공격 트래픽을 보낸 IP 주소입니다. Flagged Attackers를 조사하고 차단해야 합니다. + +
Flagged Attackers 및 Suspicious Attackers는 상호 배타적입니다. 한 IP는 동시에 두 상태로 있을 수 없습니다.
+ +### Attacker Explorer가 Signal 및 Trace Explorer와 다른 점 + +다음을 통해 다양한 탐색기 간의 차이점을 확인하세요. + +- **Protect:** ASM Protection 구성을 사용한 자동 차단. 사용자는 첫 번째 자동 차단 조치로 공격 도구를 차단해야 합니다. 공격 도구를 차단하면 SQLi, 명령 주입, SSRF 등 OWASP 위협에 대한 일반적인 취약점 발견이 줄어듭니다. +- **Reactive:** 관찰된 위협에 대응해 Signals 또는 Attackers Explorer를 사용하여 차단합니다. + +{{< img src="security/application_security/threats/attacker-explorer/attacker_explorer_nav.png" alt="ASM Attacker Explorer 탐색 스크린샷" >}} + +각 탐색기는 특정 사용 사례에 중점을 둡니다. + +- **Signal Explorer**: 크리덴셜 스터핑 공격, 명령 주입 등 실행 가능한 경고 목록입니다. 신호에는 워크플로 기능, 설명, 심각도 및 상호 연관된 트레이스가 있습니다. 상호 작용에는 사용자 할당 워크플로, 자동화된 보호, 분석, 검색 및 Trace Explore로의 피버팅이 포함됩니다. +- **Trace Explorer**: 로그인 또는 공격 페이로드와 같은 비즈니스 로직 이벤트에 대한 증거 목록입니다. 상호작용에는 분석과 검색이 포함됩니다. +- **Attacker Explorer**: Flagged 및 Suspicious Attackers 목록. 상호작용에는 다음이 포함됩니다. + - 공격자 분석 및 차단을 위한 일괄 조치 + - 공격자 기록 드릴다운 + - 검색 + - 다른 Explorer에 피버팅 + + +### 공격자 탐색 및 필터링 + +공격자를 조사하기 위해 [Attacker Explorer][1]로 이동합니다. + +{{< img src="security/application_security/threats/attacker-explorer/attacker_explorer_default_view2.png" alt="ASM Attacker Explorer" >}} + +Attacker Explorer에는 두 가지 섹션이 있습니다. + +1. 패싯과 검색. 이를 통해 서비스 또는 공격자 속성별로 트래픽을 필터링할 수 있습니다. +2. 보안 메트릭이 있는 공격자 목록. + + +### IP 조사 + +IP의 기록과 속성을 보려면 행을 클릭합니다. + +{{< img src="security/application_security/threats/attacker-explorer/ip_drawer.png" alt="ASM Attacker Explorer를 사용해 IP 주소 조사" >}} + +IP 서랍에서 IP를 차단하거나 Passlist에 추가할 수 있습니다. + +### Attacker Explorer를 이용한 차단 모범 사례 + +1. 계정 탈취 공격: IP 주소를 차단하는 데 짧은 기간을 사용합니다. +2. 활동을 관찰하되 차단을 방지하려면 모니터링되는 패스리스트에 승인된 스캐너를 추가하세요. +3. 모바일 ISP를 주의해서 차단하세요. 이러한 네트워크에는 단일 IP 주소 뒤에 수많은 사용자와 모바일 장치가 있을 수 있습니다. + +## 개별 IP 차단 + +개별 IP를 일시적 또는 영구적으로 차단하려면 다음을 수행하세요. + +{{< img src="security/application_security/threats/attacker-explorer/block_ip_address.png" alt="ASM Attacker Explorer로 IP 차단" >}} + +1. 행에서 `Block`을 클릭합니다. +2. 차단 기간을 선택합니다. + +## IP 일괄 차단 + +Attacker Explorer의 **Compare and Block** 옵션을 사용하여 여러 IP를 선택하고 일시적 또는 영구적으로 차단할 수 있습니다. + +**Compare and Block**은 안전하고 확실하게 차단할 수 있도록 IP에 대한 메트릭을 제공합니다. 예를 들어, **Similarity Overview**, **Activity**입니다. (후반부에서 자세히 설명) + +IP를 일괄적으로 비교하고 차단하려면 다음을 수행하세요. +1. 검색 또는 패싯을 사용하여 Attacker 목록을 필터링합니다. +2. 여러 IP를 선택합니다. +3. **Compare and Block** 옵션을 선택합니다. + + 다음 예에서는 선택한 IP가 동일한 위치에 있으며 서로 관련되어 있는 것으로 보입니다. **Compare and Block** 옵션은 선택된 IP 주소에 대한 메트릭과 속성을 표시하는 **Block selected attackers** 보기를 엽니다. + + {{< img src="security/application_security/threats/attacker-explorer/attacker_explorer_review_groups2.png" alt="ASM Attacker Explorer 그룹 차단 스크린샷" >}} + +4. 공격자를 차단하려면 **Block**을 클릭합니다. + +## 선택된 공격자 메트릭 차단 + + **Compare and Block** 옵션을 선택하면 **Block selected attackers** 보기가 열리고 선택한 IP 주소에 대한 메트릭과 속성이 표시됩니다. + +{{< img src="security/application_security/threats/attacker-explorer/attacker_explorer_review_groups2.png" alt="ASM Attacker Explorer 그룹 차단 스크린샷" >}} + +
Similarity Overview 및 Activity에 대한 메트릭의 범위는 지난 30일입니다.
+ +**Block selected attackers** 보기 메트릭에 대해 다음 섹션에서 확인하세요. + +### 선택된 IP + +탐색기에서 선택한 IP가 포함되어 있습니다. IP를 선택 취소하면 메트릭 섹션과 **Block** 작업에서 해당 IP가 제거됩니다. + +### Similarity Overview + +각 열은 안전하고 확실하게 차단할 수 있도록 도와줍니다. 제공된 속성은 ASM의 Attacker Similarity 기능에서도 사용됩니다. + +ASNs +: 자율 시스템 번호. 다수의 IP 주소를 사용한 공격은 동일한 ASN에서 시작될 수 있으며, 특히 공격이 데이터 센터 및 클라우드 IP에서 시작되는 경우 더욱 그렇습니다. + +사용자 에이전트 +: 공격자, 상업용 스캐너 및 자체 소프트웨어는 예측 가능한 사용자 에이전트를 사용하여 차단에 포함하거나 제외해야 하는 항목을 정합니다. + +위치 +: 회사에는 트래픽을 허용하는 국가를 결정하는 정책이나 서비스 가능한 시장이 있을 수 있습니다. + +도메인 +: ASN의 소유자입니다. 이는 조직이 여러 ASN을 소유한 경우에 유용합니다. + +IP 당 사용자 +: 해당 IP에서 인증한 사용자 수입니다. 로그인 수가 많은 IP는 로드 밸런서이거나 회사 사이트와 같이 동일한 위치에 있는 많은 사용자를 나타낼 수 있습니다. + +### Activity + +활동 기간은 30일입니다. + +#### 신호 + +선택한 시간 동안 IP 주소와 연결된 신호입니다. + +#### 트레이스 + +선택한 시간 동안 IP 주소와 연결된 트레이스입니다. + +정상 트래픽은 샘플링된 APM 트래픽이며 비즈니스 로직이나 공격 트래픽 감지가 없는 트레이스입니다. + +공격 트래픽은 비즈니스 로직을 포함한 모든 ASM 트레이스입니다. + +### 차단 + +이렇게 하면 지정된 기간 동안 [Denylist][2]에 IP 주소가 추가됩니다. + + +[1]: https://app.datadoghq.com/security/appsec/attackers +[2]: https://app.datadoghq.com/security/appsec/denylist +[3]: https://app.datadoghq.com/security/appsec/passlist \ No newline at end of file diff --git a/content/ko/security/cloud_security_management/misconfigurations/compliance_rules.md b/content/ko/security/cloud_security_management/misconfigurations/compliance_rules.md new file mode 100644 index 0000000000000..1514ceeff9f50 --- /dev/null +++ b/content/ko/security/cloud_security_management/misconfigurations/compliance_rules.md @@ -0,0 +1,112 @@ +--- +aliases: +- /ko/security_platform/cspm/configuration_rules +- /ko/security/cspm/configuration_rules +- /ko/security/cspm/detection_rules +- /ko/security/cspm/compliance_rules +- /ko/security/misconfigurations/compliance_rules +further_reading: +- link: /security/cloud_security_management/misconfigurations + tag: 설명서 + text: CSM Misconfigurations 시작하기 +- link: /security/cloud_security_management/misconfigurations/custom_rules/ + tag: 설명서 + text: 커스텀 규칙 +- link: /security/cloud_security_management/misconfigurations/frameworks_and_benchmarks/ + tag: 설명서 + text: Misconfigurations Reports +title: CSM Misconfigurations 컴플라이언스 규칙 관리 +--- + +Cloud Security Management Misconfigurations (CSM Misconfigurations) [기본 컴플라이언스 규칙][1]은 클라우드 리소스의 구성을 평가하고 잠재적인 구성 오류를 식별하여 즉시 해결 조치를 취할 수 있도록 합니다. + +컴플라이언스 규칙은 모든 Datadog Security 컴플라이언스 규칙과 동일한 [조건부 논리][2]를 따릅니다. CSM Misconfigurations의 경우 각 규칙은 하나 이상의 [컴플라이언스 프레임워크 또는 업계 벤치마크][4] 내의 제어에 매핑됩니다. + +CSM Misconfigurations는 다음 규칙 유형을 사용하여 클라우드 인프라스트럭처 구성을 검증합니다. + +- [**클라우드 구성**][1]: 이 컴플라이언스 규칙은 클라우드 환경 내의 리소스 구성을 분석합니다. 예를 들어, [Cloudfront distribution is encrypted][3] 규칙은 Amazon CloudFront 배포 구성의 암호화된 상태를 평가합니다. +- [**인프라스트럭처 구성**][5]: 이 컴플라이언스 규칙은 Docker 및 Kubernetes에 대한 CIS 컴플라이언스 벤치마크에 정의된 대로 컨테이너 및 Kubernetes 클러스터를 분석하여 구성 문제를 찾습니다. 예를 들어, [/etc/default/docker file permissions are set to 644 or more restrictively][6] 규칙은 호스트에서 실행되는 Docker 파일 권한을 평가합니다. + +## 기본 컴플라이언스 규칙 살펴보기 + +클라우드 공급자별로 기본 컴플라이언스 규칙을 필터링하려면: + +1. [**Misconfiguration Rules**][13] 페이지로 이동합니다. +2. **Tag** 패싯에서 다음 값 중 하나를 선택합니다. + - **AWS**: cloud_provider:aws + - **Azure**: cloud_provider:azure + - **Google Cloud**: cloud_provider:gcp + - **Docker**: framework:cis-docker + - **Kubernetes**: framework:cis-kubernetes + +## 각 규칙에 따라 환경을 검사하는 방법을 사용자 정의합니다. + +클라우드 구성 쿼리를 직접 사용자 정의하는 것은 현재 지원되지 않지 않습니다. 하지만 각 규칙에 따라 환경을 검사하는 방법을 사용자 정의할 수 있습니다. + +[Rules][13] 페이지에서 규칙을 선택하여 세부정보 페이지를 엽니다. **Exclude benign activity with suppression queries**에서 규칙이 환경을 스캔하는 방법에 대한 필터링 논리를 설정합니다. + +예를 들어 **This rule will not generate a misconfiguration if there is a match with any of the following suppression queries** 기능을 사용하여 `env:staging`로 태그가 지정된 리소스를 제외할 수 있습니다. **Only generate a misconfiguration if there is a match with any of the following queries** 기능을 사용하여 특정 규칙의 범위를 `compliance:pci` 태그가 지정된 리소스로 제한할 수도 있습니다. + +규칙을 설정한 후 페이지 하단의 **Update Rule**를 클릭하여 변경사항을 적용합니다. + +{{< img src="security/cspm/frameworks_and_benchmarks/never-trigger-misconfiguration.png" alt="규칙 범위에 포함하거나 제외할 태그를 선택하여 환경 검사 방법을 사용자 정의하세요" >}} + +## 컴플라이언스 규칙에 대한 알림 대상 설정 + +알림 대상을 추가해 환경에서 새로운 구성 오류가 감지되면 실시간 알림을 보낼 수 있습니다. 사용 가능한 알림 옵션은 다음과 같습니다. + +- [Slack][14] +- [Jira][15] +- [PagerDuty][16] +- [ServiceNow][17] +- [Microsoft Teams][18] +- [Webhooks][19] +- 이메일 + +[Rules][13] 페이지에서 규칙을 선택하여 세부정보 페이지를 엽니다. **Set severity and notifications** 섹션에서 각 규칙 사례에 대해 0개 이상의 알림 대상을 구성합니다. 미리 설정된 심각도는 수정할 수 없습니다. 컴플라이언스 규칙에 대한 알림 구성 지침은 [Notifications][7]를 참조하세요. + +또는 심각도, 규칙 유형, 규칙 태그, 신호 속성 및 신호 태그와 같은 파라미터를 기반으로 여러 컴플라이언스 규칙에 걸쳐 있는 [알림 규칙][21]을 만듭니다. 이를 통해 개별 컴플라이언스 규칙에 대한 알림 기본 설정을 수동으로 편집할 필요가 없습니다. + +**참고**: 알림이 활성화된 규칙에 대해 잘못된 구성이 감지되면 실패한 구성이 [Signals Explorer][22]에도 나타납니다. + +{{< img src="security/cspm/frameworks_and_benchmarks/notification-2.png" alt="규칙 세부정보 페이지의Set severity and notifications 섹션" >}} + +## 커스텀 규칙 만들기 + +커스텀 규칙을 생성하여 환경에 적용되는 규칙을 확장하고 보안 상태를 평가할 수 있습니다. 또한 기본 감지 규칙을 복제하고 사본을 편집할 수도 있습니다(Google Cloud에만 해당). 자세한 내용은 [커스텀 규칙][20]을 참조하세요. + +## 사용되지 않는 규칙 + +고품질의 성능을 유지하기 위해 모든 컴플라이언스 규칙에 대한 정기적인 감사가 수행됩니다. 더 이상 사용되지 않는 규칙은 개선된 규칙으로 대체됩니다. + +사용되지 않는 규칙은 다음 프로세스를 통해 결정됩니다. + +1. 규칙에 사용되지 않는 날짜 경고가 있습니다. UI의 다음 위치에서 이 경고가 표시됩니다. + - 신호 사이드 패널의 **Rule Details > Playbook** 섹션 + - Misconfigurations 사이드 패널 + - 해당 특정 규칙에 대한 [규칙 편집기][23] +2. 규칙이 더 이상 사용되지 않으면 규칙이 삭제되기까지 15개월의 기간이 있습니다. 이는 신호 유지 기간이 15개월이기 때문입니다. 이 시간 동안 UI에서 [규칙 복제][23]를 통해 규칙을 다시 활성화할 수 있습니다. +3. 규칙이 삭제된 후에는 복제하여 재활성화할 수 없습니다. + +## 참고 자료 + +{{< partial name="whats-next/whats-next.html" >}} + +[1]: /ko/security/default_rules/#cat-csm-misconfigurations-cloud +[2]: /ko/security/detection_rules/ +[3]: https://docs.datadoghq.com/ko/security_monitoring/default_rules/aws-cloudfront-distributions-encrypted/ +[4]: /ko/security/cloud_security_management/misconfigurations/frameworks_and_benchmarks +[5]: /ko/security/default_rules/#cat-posture-management-infra +[6]: https://docs.datadoghq.com/ko/security_monitoring/default_rules/cis-docker-1.2.0-3.22/ +[7]: /ko/security/notifications/ +[13]: https://app.datadoghq.com/security/configuration/compliance/rules +[14]: /ko/integrations/slack/ +[15]: /ko/integrations/jira/ +[16]: /ko/integrations/pagerduty +[17]: /ko/integrations/servicenow/ +[18]: /ko/integrations/microsoft_teams/ +[19]: /ko/integrations/webhooks/ +[20]: /ko/security/cloud_security_management/misconfigurations/custom_rules/ +[21]: /ko/security/notifications/rules/ +[22]: /ko/security/cloud_security_management/misconfigurations/signals_explorer/ +[23]: /ko/security/detection_rules/#clone-a-rule \ No newline at end of file diff --git a/content/ko/serverless/aws_lambda/configuration.md b/content/ko/serverless/aws_lambda/configuration.md index ccb1974e454b3..425b81cd4587f 100644 --- a/content/ko/serverless/aws_lambda/configuration.md +++ b/content/ko/serverless/aws_lambda/configuration.md @@ -107,7 +107,7 @@ title: AWS Lambda용 서버리스 모니터링 구성 environment: DD_UNIVERSAL_INSTRUMENTATION: true ``` - **NodeJS 또는 파이썬 함수**의 경우 다음을 추가하세요; + **Node.js 또는 파이썬 함수**의 경우 다음을 추가하세요; ```yaml environment: DD_EXPERIMENTAL_ENABLE_PROXY: true diff --git a/content/ko/serverless/libraries_integrations/cli.md b/content/ko/serverless/libraries_integrations/cli.md index 3a1101c516048..478d50b717407 100644 --- a/content/ko/serverless/libraries_integrations/cli.md +++ b/content/ko/serverless/libraries_integrations/cli.md @@ -113,7 +113,7 @@ datadog-ci lambda uninstrument -f -f -r | `--no-source-code-integration` | | Datadog 소스 코드 통합을 비활성화합니다. | | | `--upload-git-metadata` | `-u` | 소스 코드 통합의 일부로 Git 메타데이터 업로드를 사용할지 여부입니다. Datadog Github 통합을 설치하지 않은 경우에만 Git 메타데이터 업로드가 필요합니다. | `true` | | `--no-upload-git-metadata` | | 소스 코드 통합의 일부로 Git 메타데이터 업로드를 비활성화합니다. Datadog Github 통합을 설치한 경우 Git 메타데이터 업로드가 불필요하므로 이 플래그를 사용합니다. | | -| `--apm-flush-deadline` | | 밀리초에서 시간 초과하기 전에 기간을 제출할 시기를 결정하는 데 사용됩니다. AWS 람다 호출의 남은 시간이 설정된 값보다 작으면 추적기는 현재 활성 스팬(span)과 완료된 모든 스팬(span)을 제출하려고 시도합니다. NodeJS 및 파이썬(Python)에서 지원됩니다. 기본값은 `100`밀리초입니다. | | +| `--apm-flush-deadline` | | 밀리초에서 시간 초과하기 전에 기간을 제출할 시기를 결정하는 데 사용됩니다. AWS 람다 호출의 남은 시간이 설정된 값보다 작으면 추적기는 현재 활성 스팬(span)과 완료된 모든 스팬(span)을 제출하려고 시도합니다. Node.js 및 파이썬(Python)에서 지원됩니다. 기본값은 `100`밀리초입니다. | |
#### `uninstrument` diff --git a/content/ko/serverless/libraries_integrations/macro.md b/content/ko/serverless/libraries_integrations/macro.md index 2af263d9d0fe0..5ede5c93783f3 100644 --- a/content/ko/serverless/libraries_integrations/macro.md +++ b/content/ko/serverless/libraries_integrations/macro.md @@ -140,13 +140,13 @@ aws cloudformation update-stack \ | `tags` | 쉼표로 구분된 목록 키: 값 쌍을 하나의 문자열로 만듭니다. `extensionLayerVersion`와 함께 설정하면 `DD_TAGS` 환경 변수가 제공된 값으로 모든 람다 함수에 추가됩니다. `forwarderArn`와 함께 설정하면 매크로가 문자열을 파싱하여 모든 람다 함수에서 각 키:값 쌍을 태그로 설정합니다. | | `logLevel` | 로그 레벨을 설정합니다. 확장 로깅의 경우 `DEBUG`로 설정합니다. | | `captureLambdaPayload` | 요청 및 응답 페이로드가 있는 함수 실행 범위에 자동으로 태그를 지정하여 APM 애플리케이션에 표시할 수 있습니다. | -| `enableColdStartTracing` | 콜드 스타트 추적을 비활성화하려면 `false`로 설정합니다. NodeJS 및 파이썬(Python)에서 사용됩니다. 기본값은 `true`입니다. | +| `enableColdStartTracing` | 콜드 스타트 추적을 비활성화하려면 `false`로 설정합니다. Node.js 및 파이썬(Python)에서 사용됩니다. 기본값은 `true`입니다. | | `coldStartTraceMinDuration` | 콜드 스타트 추적을 통해 추적할 모듈 로드 이벤트의 최소 지속 시간 (밀리초)을 설정합니다. 번호. 기본값은`3` 입니다. | | `coldStartTraceSkipLibs` | (선택 사항) 쉼표로 구분된 라이브러리 목록에 대한 콜드 스타트 스팬 생성을 건너뛸 수 있습니다. 깊이를 제한하거나 알려진 라이브러리를 건너뛸 때 유용합니다. 기본값은 런타임에 따라 다릅니다. | -| `enableProfiling` | `true`로 설정해 Datadog Continuous Profiler를 활성화합니다. NodeJS 및 파이썬(Python)용은 베타 버전에서 지원됩니다. 기본값은 `false`입니다. | -| `encodeAuthorizerContext` | 람다 인증자에 대해 `true`로 설정하면 추적 컨텍스트가 전파를 위해 응답으로 인코딩됩니다. NodeJS 및 파이썬(Python)에서 지원됩니다. 기본값은 `true`입니다. | -| `decodeAuthorizerContext` | 람다 인증자를 통해 인증된 람다에 대해 `true`로 설정하면 인코딩된 추적 컨텍스트를 구문 분석하여 사용합니다 (있는 경우). NodeJS 및 파이썬(Python)에서 지원됩니다. 기본값은 `true`입니다. | -| `apmFlushDeadline` | 시간 초과가 발생하기 전에 스팬을 제출할 시점을 밀리초 단위로 결정하는 데 사용됩니다. AWS 람다 호출의 남은 시간이 설정된 값보다 작으면 추적기는 현재 활성 스팬과 완료된 모든 스팬을 제출하려고 시도합니다. NodeJS 및 파이썬(Python)에서 지원됩니다. 기본값은 `100`밀리초입니다. | +| `enableProfiling` | `true`로 설정해 Datadog Continuous Profiler를 활성화합니다. Node.js 및 파이썬(Python)용은 베타 버전에서 지원됩니다. 기본값은 `false`입니다. | +| `encodeAuthorizerContext` | 람다 인증자에 대해 `true`로 설정하면 추적 컨텍스트가 전파를 위해 응답으로 인코딩됩니다. Node.js 및 파이썬(Python)에서 지원됩니다. 기본값은 `true`입니다. | +| `decodeAuthorizerContext` | 람다 인증자를 통해 인증된 람다에 대해 `true`로 설정하면 인코딩된 추적 컨텍스트를 구문 분석하여 사용합니다 (있는 경우). Node.js 및 파이썬(Python)에서 지원됩니다. 기본값은 `true`입니다. | +| `apmFlushDeadline` | 시간 초과가 발생하기 전에 스팬을 제출할 시점을 밀리초 단위로 결정하는 데 사용됩니다. AWS 람다 호출의 남은 시간이 설정된 값보다 작으면 추적기는 현재 활성 스팬과 완료된 모든 스팬을 제출하려고 시도합니다. Node.js 및 파이썬(Python)에서 지원됩니다. 기본값은 `100`밀리초입니다. | ## 작동 방식 diff --git a/content/ko/serverless/libraries_integrations/plugin.md b/content/ko/serverless/libraries_integrations/plugin.md index 3db39b55934f8..56a728ad4703c 100644 --- a/content/ko/serverless/libraries_integrations/plugin.md +++ b/content/ko/serverless/libraries_integrations/plugin.md @@ -62,14 +62,14 @@ Datadog는 서버리스 애플리케이션을 구축하기 위해 서버리스 | `failOnError` | 설정되면 Datadog 모니터가 생성이나 업데이트에 실패했을 때 오류를 트리거합니다. 배포 후에 발생할 수 있지만 0이 아닌 종료 코드를 반환하기 위해(사용자 CI 실패를 위해) `serverless deploy`를 발생시킬 수 있습니다. 기본값은 `false`로 설정됩니다. | | `logLevel` | 로그 수준으로, 확장된 로깅을 위해 `DEBUG`로 설정됩니다. | | `skipCloudformationOutputs` | 스택에 Datadog Cloudformation Outputs 추가하기를 건너뛰려면 `true`로 설정합니다. 200개 출력 제한은 스택 생성을 실패하게 할 수 있으므로 이 경우 유용합니다. | -| `enableColdStartTracing` | 콜드 스타트 추적을 비활성화하려면 `false`로 설정합니다. NodeJS 및 파이썬(Python)에서 사용됩니다. 기본값은 `true`입니다. | +| `enableColdStartTracing` | 콜드 스타트 추적을 비활성화하려면 `false`로 설정합니다. Node.js 및 파이썬(Python)에서 사용됩니다. 기본값은 `true`입니다. | | `coldStartTraceMinDuration` | 콜드 스타트 추적을 통해 추적할 모듈 로드 이벤트의 최소 지속 시간(밀리초)을 설정합니다. 번호. 기본값은`3` 입니다. | | `coldStartTraceSkipLibs` | 선택적으로 쉼표로 구분된 라이브러리 목록에 대해 콜드 스타트 스팬(span) 만들기를 건너뜁니다. 깊이를 제한하거나 알려진 라이브러리를 건너뛸 때 유용합니다. 기본값은 런타임에 따라 다릅니다. | | `subdomain` | 부수적인 하위 도메인을 설정하여 출력 생성을 위해 프린트되는 앱 URL을 사용합니다. 기본값은 `app`으로 설정됩니다. | -| `enableProfiling` | `true`와 함께 Datadog 계속적인 프로파일러를 사용하도록 설정합니다. NodeJS 및 파이썬(Python)용 베타에서 지원됩니다. 기본값은 `false`입니다. | -| `encodeAuthorizerContext` | 람다 승인자에 대해 `true`로 설정하면 추적 컨텍스트가 전파를 위해 응답으로 인코딩됩니다. NodeJS 및 파이썬(Python)에서 지원됩니다. 기본값은 `true`입니다. | -| `decodeAuthorizerContext` | 람다 인증자를 통해 인증된 람다에 대해 `true`로 설정하면 인코딩된 추적 컨텍스트를 구문 분석하고 사용합니다(찾은 경우). NodeJS 및 파이썬(Python)에서 지원됩니다. 기본값은 `true`입니다. | -| `apmFlushDeadline` | 밀리초에서 시간 초과하기 전에 기간을 제출할 시기를 결정하는 데 사용됩니다. AWS 람다 호출의 남은 시간이 설정된 값보다 작으면 추적기는 현재 활성 스팬(span)과 완료된 모든 스팬(span)을 제출하려고 시도합니다. NodeJS 및 파이썬(Python)에서 지원됩니다. 기본값은 `100`밀리초입니다. | +| `enableProfiling` | `true`와 함께 Datadog 계속적인 프로파일러를 사용하도록 설정합니다. Node.js 및 파이썬(Python)용 베타에서 지원됩니다. 기본값은 `false`입니다. | +| `encodeAuthorizerContext` | 람다 승인자에 대해 `true`로 설정하면 추적 컨텍스트가 전파를 위해 응답으로 인코딩됩니다. Node.js 및 파이썬(Python)에서 지원됩니다. 기본값은 `true`입니다. | +| `decodeAuthorizerContext` | 람다 인증자를 통해 인증된 람다에 대해 `true`로 설정하면 인코딩된 추적 컨텍스트를 구문 분석하고 사용합니다(찾은 경우). Node.js 및 파이썬(Python)에서 지원됩니다. 기본값은 `true`입니다. | +| `apmFlushDeadline` | 밀리초에서 시간 초과하기 전에 기간을 제출할 시기를 결정하는 데 사용됩니다. AWS 람다 호출의 남은 시간이 설정된 값보다 작으면 추적기는 현재 활성 스팬(span)과 완료된 모든 스팬(span)을 제출하려고 시도합니다. Node.js 및 파이썬(Python)에서 지원됩니다. 기본값은 `100`밀리초입니다. | 이 파라미터를 사용하려면 이 예시와 유사한 `serverless.yml`에 `custom` > `datadog` 섹션을 추가합니다. diff --git a/content/ko/tracing/guide/agent-5-tracing-setup.md b/content/ko/tracing/guide/agent-5-tracing-setup.md index d2b19998411a4..94e2994c19522 100644 --- a/content/ko/tracing/guide/agent-5-tracing-setup.md +++ b/content/ko/tracing/guide/agent-5-tracing-setup.md @@ -39,7 +39,7 @@ APM는 리눅스와 도커에서 Datadog Agent 5.13 이상의 버전을 사용 {{< nextlink href="tracing/setup/python" tag="Python" >}}파이썬(Python) 언어 계측.{{< /nextlink >}} {{< nextlink href="tracing/setup/ruby" tag="Ruby" >}}Ruby 언어 계측{{< /nextlink >}} {{< nextlink href="tracing/setup/go" tag="Go" >}}Go 언어 계측.{{< /nextlink >}} - {{< nextlink href="tracing/setup/nodejs" tag="Nodejs" >}}Node.js 언어 계측.{{< /nextlink >}} + {{< nextlink href="tracing/setup/nodejs" tag="Node.js" >}}Node.js 언어 계측.{{< /nextlink >}} {{< nextlink href="tracing/setup/dotnet" tag=".NET" >}}.NET 언어 계측.{{< /nextlink >}} {{< nextlink href="tracing/setup/php" tag="PHP" >}}PHP 언어 계측.{{< /nextlink >}} {{< /whatsnext >}} diff --git a/content/ko/tracing/guide/inferred-service-opt-in.md b/content/ko/tracing/guide/inferred-service-opt-in.md index 0d50c1b763370..62958f15867c6 100644 --- a/content/ko/tracing/guide/inferred-service-opt-in.md +++ b/content/ko/tracing/guide/inferred-service-opt-in.md @@ -26,7 +26,7 @@ Datadog는 아직 종속성 여부가 추론되지 않았다 하더라도, 데 Datadog은 추론 서비스의 이름과 유형을 결정하기 위해 스팬(span) 속성을 사용합니다. 추론한 외부 API는 기본 명명체계 `net.peer.name`를 따릅니다. (예: `api.stripe.com`, `api.twilio.com`, `us6.api.mailchimp.com`) 추론 데이터베이스는 기본 명명체계 `db.instance`를 따릅니다. -Go, 자바(Java), NodeJS, PHP, .NET 또는 루비(Ruby) 트레이서를 사용한다면, 추론 서비스의 이름 기본값을 사용자 지정할 수 있습니다. 자세한 내용을 확인하려면 하단의 해당 언어용 '피어 서비스 매핑' 섹션을 참조하세요. +Go, 자바(Java), Node.js, PHP, .NET 또는 루비(Ruby) 트레이서를 사용한다면, 추론 서비스의 이름 기본값을 사용자 지정할 수 있습니다. 자세한 내용을 확인하려면 하단의 해당 언어용 '피어 서비스 매핑' 섹션을 참조하세요. **참고**: 베타 기간 동안 모니터, 대시보드, 또는 노트북을 지정 추론 서비스로 설정하는 경우, 명명체계 변경 시 이를 업데이트해야 할 수도 있습니다. @@ -132,9 +132,9 @@ DD_TRACE_PEER_SERVICE_MAPPING=10.0.32.3:my-service {{% /tab %}} -{{% tab "NodeJS" %}} +{{% tab "Node.js" %}} -필수 NodeJS 트레이서 버전은 최소 [2.44.0][1], [3.31.0][2] 또는 [4.10.0][3]입니다. 변경 사항 및 버그 수정에 접근하려면 정기적으로 최신 버전으로 업데이트합니다 +필수 Node.js 트레이서 버전은 최소 [2.44.0][1], [3.31.0][2] 또는 [4.10.0][3]입니다. 변경 사항 및 버그 수정에 접근하려면 정기적으로 최신 버전으로 업데이트합니다 옵트인(opt in)하려면 트레이서 설정에 다음 환경 변수 또는 시스템 속성을 추가하세요: diff --git a/data/api/v1/full_spec.yaml b/data/api/v1/full_spec.yaml index d09dbdf509005..8a6169e3a2b67 100644 --- a/data/api/v1/full_spec.yaml +++ b/data/api/v1/full_spec.yaml @@ -15728,14 +15728,14 @@ components: type: boolean name: description: The name of the step. + example: '' maxLength: 1500 type: string noScreenshot: description: A boolean set to not take a screenshot for the step. type: boolean params: - description: The parameters of the mobile step. - type: object + $ref: '#/components/schemas/SyntheticsMobileStepParams' publicId: description: The public ID of the step. example: pub-lic-id0 @@ -15746,6 +15746,188 @@ components: type: integer type: $ref: '#/components/schemas/SyntheticsMobileStepType' + required: + - name + - params + - type + type: object + SyntheticsMobileStepParams: + description: The parameters of a mobile step. + properties: + check: + $ref: '#/components/schemas/SyntheticsCheckType' + delay: + description: Number of milliseconds to wait between inputs in a `typeText` + step type. + format: int64 + maximum: 5000 + minimum: 0 + type: integer + direction: + $ref: '#/components/schemas/SyntheticsMobileStepParamsDirection' + element: + $ref: '#/components/schemas/SyntheticsMobileStepParamsElement' + enable: + description: Boolean to change the state of the wifi for a `toggleWiFi` + step type. + type: boolean + maxScrolls: + description: Maximum number of scrolls to do for a `scrollToElement` step + type. + format: int64 + type: integer + positions: + $ref: '#/components/schemas/SyntheticsMobileStepParamsPositions' + subtestPublicId: + description: Public ID of the test to be played as part of a `playSubTest` + step type. + type: string + value: + description: Values used in the step. Used in multiple step types. + type: string + variable: + $ref: '#/components/schemas/SyntheticsMobileStepParamsVariable' + withEnter: + description: Boolean to indicate if `Enter` should be pressed at the end + of the `typeText` step type. + type: boolean + x: + description: Amount to scroll by on the `x` axis for a `scroll` step type. + format: int64 + type: integer + y: + description: Amount to scroll by on the `y` axis for a `scroll` step type. + format: int64 + type: integer + type: object + SyntheticsMobileStepParamsDirection: + description: The direction of the scroll for a `scrollToElement` step type. + enum: + - up + - down + - left + - right + type: string + x-enum-varnames: + - UP + - DOWN + - LEFT + - RIGHT + SyntheticsMobileStepParamsElement: + description: Information about the element used for a step. + properties: + context: + description: Context of the element. + type: string + contextType: + $ref: '#/components/schemas/SyntheticsMobileStepParamsElementContextType' + elementDescription: + description: Description of the element. + type: string + multiLocator: + description: Multi-locator to find the element. + type: object + relativePosition: + $ref: '#/components/schemas/SyntheticsMobileStepParamsElementRelativePosition' + textContent: + description: Text content of the element. + type: string + userLocator: + $ref: '#/components/schemas/SyntheticsMobileStepParamsElementUserLocator' + viewName: + description: Name of the view of the element. + type: string + type: object + SyntheticsMobileStepParamsElementContextType: + description: Type of the context that the element is in. + enum: + - native + - web + type: string + x-enum-varnames: + - NATIVE + - WEB + SyntheticsMobileStepParamsElementRelativePosition: + description: Position of the action relative to the element. + properties: + x: + description: The `relativePosition` on the `x` axis for the element. + format: int64 + type: integer + y: + description: The `relativePosition` on the `y` axis for the element. + format: int64 + type: integer + type: object + SyntheticsMobileStepParamsElementUserLocator: + description: User locator to find the element. + properties: + failTestOnCannotLocate: + description: Whether if the the test should fail if the element cannot be + found. + type: boolean + values: + description: Values of the user locator. + items: + $ref: '#/components/schemas/SyntheticsMobileStepParamsElementUserLocatorValuesItems' + type: array + type: object + SyntheticsMobileStepParamsElementUserLocatorValuesItems: + description: A single user locator object. + properties: + type: + $ref: '#/components/schemas/SyntheticsMobileStepParamsElementUserLocatorValuesItemsType' + value: + description: Value of a user locator. + type: string + type: object + SyntheticsMobileStepParamsElementUserLocatorValuesItemsType: + description: Type of a user locator. + enum: + - accessibility-id + - id + - ios-predicate-string + - ios-class-chain + - xpath + type: string + x-enum-varnames: + - ACCESSIBILITY_ID + - ID + - IOS_PREDICATE_STRING + - IOS_CLASS_CHAIN + - XPATH + SyntheticsMobileStepParamsPositions: + description: List of positions for the `flick` step type. The maximum is 10 + flicks per step + items: + $ref: '#/components/schemas/SyntheticsMobileStepParamsPositionsItems' + type: array + SyntheticsMobileStepParamsPositionsItems: + description: A description of a single position for a `flick` step type. + properties: + x: + description: The `x` position for the flick. + format: int64 + type: integer + y: + description: The `y` position for the flick. + format: int64 + type: integer + type: object + SyntheticsMobileStepParamsVariable: + description: Variable object for `extractVariable` step type. + properties: + example: + description: An example for the variable. + example: '' + type: string + name: + description: The variable name. + example: VAR_NAME + type: string + required: + - name + - example type: object SyntheticsMobileStepType: description: Step type used in your mobile Synthetic test. @@ -15793,7 +15975,7 @@ components: config: $ref: '#/components/schemas/SyntheticsMobileTestConfig' device_ids: - description: The `SyntheticsMobileTest` `device_ids`. + description: Array with the different device IDs used to run the test. items: $ref: '#/components/schemas/SyntheticsMobileDeviceID' type: array @@ -15841,44 +16023,6 @@ components: - options - type type: object - SyntheticsMobileTestBinding: - description: Objects describing the binding used for a mobile test. - properties: - items: - $ref: '#/components/schemas/SyntheticsMobileTestBindingItems' - type: object - SyntheticsMobileTestBindingItems: - description: Object describing the binding used for a mobile test. - properties: - principals: - $ref: '#/components/schemas/SyntheticsMobileTestBindingPrincipals' - role: - $ref: '#/components/schemas/SyntheticsMobileTestBindingItemsRole' - type: object - SyntheticsMobileTestBindingItemsRole: - description: The definition of `SyntheticsMobileTestBindingItemsRole` object. - enum: - - editor - - viewer - type: string - x-enum-varnames: - - EDITOR - - VIEWER - SyntheticsMobileTestBindingPrincipals: - description: List of principals for a mobile test binding. - items: - description: A principal for a mobile test binding. - maxLength: 1500 - type: string - type: array - SyntheticsMobileTestCiOptions: - description: CI/CD options for a Synthetic test. - properties: - executionRule: - $ref: '#/components/schemas/SyntheticsTestExecutionRule' - required: - - executionRule - type: object SyntheticsMobileTestConfig: description: Configuration object for a Synthetic mobile test. properties: @@ -15891,34 +16035,27 @@ components: type: array type: object SyntheticsMobileTestInitialApplicationArguments: + additionalProperties: + description: A single application argument. + type: string description: Initial application arguments for a mobile test. - properties: - propertyNames: - $ref: '#/components/schemas/SyntheticsMobileTestInitialApplicationArgumentsPropertyNames' - type: object - SyntheticsMobileTestInitialApplicationArgumentsPropertyNames: - description: Name of the property. - properties: - pattern: - description: The `propertyNames` `pattern`. - example: ^(?!_dd).*$ - type: string type: object SyntheticsMobileTestOptions: description: Object describing the extra options for a Synthetic test. properties: allowApplicationCrash: - description: The `SyntheticsMobileTestOptions` `allowApplicationCrash`. + description: A boolean to set if an application crash would mark the test + as failed. type: boolean bindings: description: Array of bindings used for the mobile test. items: - $ref: '#/components/schemas/SyntheticsMobileTestBinding' + $ref: '#/components/schemas/SyntheticsTestRestrictionPolicyBinding' type: array ci: - $ref: '#/components/schemas/SyntheticsMobileTestCiOptions' + $ref: '#/components/schemas/SyntheticsTestCiOptions' defaultStepTimeout: - description: The `SyntheticsMobileTestOptions` `defaultStepTimeout`. + description: The default timeout for steps in the test (in seconds). format: int32 maximum: 300 minimum: 1 @@ -15926,11 +16063,13 @@ components: device_ids: description: For mobile test, array with the different device IDs used to run the test. + example: + - synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16 items: $ref: '#/components/schemas/SyntheticsMobileDeviceID' type: array disableAutoAcceptAlert: - description: The `SyntheticsMobileTestOptions` `disableAutoAcceptAlert`. + description: A boolean to disable auto accepting alerts. type: boolean min_failure_duration: description: Minimum amount of time in failure required to trigger an alert. @@ -15945,7 +16084,7 @@ components: all monitor dashboard widgets and SLOs. type: string monitor_options: - $ref: '#/components/schemas/SyntheticsMobileTestOptionsMonitorOptions' + $ref: '#/components/schemas/SyntheticsTestOptionsMonitorOptions' monitor_priority: description: Integer from 1 (high) to 5 (low) indicating alert severity. format: int32 @@ -15953,7 +16092,7 @@ components: minimum: 1 type: integer noScreenshot: - description: The `SyntheticsMobileTestOptions` `noScreenshot`. + description: A boolean set to not take a screenshot for the step. type: boolean restricted_roles: $ref: '#/components/schemas/SyntheticsRestrictedRoles' @@ -15963,54 +16102,22 @@ components: $ref: '#/components/schemas/SyntheticsTestOptionsScheduling' tick_every: description: The frequency at which to run the Synthetic test (in seconds). + example: 300 format: int64 maximum: 604800 minimum: 300 type: integer verbosity: - description: The `SyntheticsMobileTestOptions` `verbosity`. + description: The level of verbosity for the mobile test. format: int32 maximum: 5 minimum: 0 type: integer + required: + - device_ids + - tick_every + - mobileApplication type: object - SyntheticsMobileTestOptionsMonitorOptions: - description: 'Object containing the options for a mobile Synthetic test as a - monitor - - (for example, renotification).' - properties: - escalation_message: - description: Message to include in the escalation notification. - type: string - notification_preset_name: - $ref: '#/components/schemas/SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName' - renotify_interval: - description: 'Time interval before renotifying if the test is still failing - - (in minutes).' - format: int64 - minimum: 0 - type: integer - renotify_occurrences: - description: The `SyntheticsMobileTestOptionsMonitorOptions` `renotify_occurrences`. - format: int64 - type: integer - type: object - SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName: - description: The definition of `SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName` - object. - enum: - - show_all - - hide_all - - hide_query - - hide_handles - type: string - x-enum-varnames: - - SHOW_ALL - - HIDE_ALL - - HIDE_QUERY - - HIDE_HANDLES SyntheticsMobileTestType: default: mobile description: Type of the Synthetic test, `mobile`. @@ -16025,14 +16132,20 @@ components: properties: applicationId: description: Application ID of the mobile application. + example: 00000000-0000-0000-0000-aaaaaaaaaaaa maxLength: 1500 type: string referenceId: description: Reference ID of the mobile application. + example: 00000000-0000-0000-0000-aaaaaaaaaaab maxLength: 1500 type: string referenceType: $ref: '#/components/schemas/SyntheticsMobileTestsMobileApplicationReferenceType' + required: + - applicationId + - referenceId + - referenceType type: object SyntheticsMobileTestsMobileApplicationReferenceType: description: Reference type for the mobile application for a mobile synthetics @@ -16040,6 +16153,7 @@ components: enum: - latest - version + example: latest type: string x-enum-varnames: - LATEST @@ -16513,6 +16627,8 @@ components: properties: executionRule: $ref: '#/components/schemas/SyntheticsTestExecutionRule' + required: + - executionRule type: object SyntheticsTestConfig: description: Configuration object for a Synthetic test. @@ -16774,6 +16890,11 @@ components: (for example, renotification).' properties: + escalation_message: + description: Message to include in the escalation notification. + type: string + notification_preset_name: + $ref: '#/components/schemas/SyntheticsTestOptionsMonitorOptionsNotificationPresetName' renotify_interval: description: 'Time interval before renotifying if the test is still failing @@ -16781,7 +16902,24 @@ components: format: int64 minimum: 0 type: integer + renotify_occurrences: + description: The number of times to renotify if the test is still failing. + format: int64 + type: integer type: object + SyntheticsTestOptionsMonitorOptionsNotificationPresetName: + description: The name of the preset for the notification for the monitor. + enum: + - show_all + - hide_all + - hide_query + - hide_handles + type: string + x-enum-varnames: + - SHOW_ALL + - HIDE_ALL + - HIDE_QUERY + - HIDE_HANDLES SyntheticsTestOptionsRetry: description: Object describing the retry strategy to apply to a Synthetic test. properties: @@ -16820,6 +16958,9 @@ components: description: Timezone in which the timeframe is based. example: America/New_York type: string + required: + - timeframes + - timezone type: object SyntheticsTestOptionsSchedulingTimeframe: description: Object describing a timeframe. @@ -16839,6 +16980,10 @@ components: description: The hour of the day on which scheduling ends. example: '16:00' type: string + required: + - day + - from + - to type: object SyntheticsTestPauseStatus: description: 'Define whether you want to start (`live`) or pause (`paused`) @@ -17075,6 +17220,30 @@ components: description: String Port number to use when performing the test. Supports templated variables. type: string + SyntheticsTestRestrictionPolicyBinding: + description: Objects describing the binding used for a mobile test. + properties: + principals: + $ref: '#/components/schemas/SyntheticsTestRestrictionPolicyBindingPrincipals' + relation: + $ref: '#/components/schemas/SyntheticsTestRestrictionPolicyBindingRelation' + type: object + SyntheticsTestRestrictionPolicyBindingPrincipals: + description: List of principals for a mobile test binding. + items: + description: A principal for a mobile test binding. + maxLength: 1500 + type: string + type: array + SyntheticsTestRestrictionPolicyBindingRelation: + description: The type of relation for the binding. + enum: + - editor + - viewer + type: string + x-enum-varnames: + - EDITOR + - VIEWER SyntheticsTestUptime: description: Object containing the uptime for a Synthetic test ID. properties: diff --git a/data/api/v1/full_spec_deref.json b/data/api/v1/full_spec_deref.json index 0390d7343d970..2979de233607d 100644 --- a/data/api/v1/full_spec_deref.json +++ b/data/api/v1/full_spec_deref.json @@ -490314,6 +490314,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -490414,11 +490417,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -490532,6 +490560,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -490542,6 +490575,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -501145,6 +501182,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -501245,11 +501285,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -501363,6 +501428,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -501373,6 +501443,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -510368,6 +510442,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -510468,11 +510545,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -510586,6 +510688,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -510596,6 +510703,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -510856,6 +510967,7 @@ }, "name": { "description": "The name of the step.", + "example": "", "maxLength": 1500, "type": "string" }, @@ -510864,7 +510976,235 @@ "type": "boolean" }, "params": { - "description": "The parameters of the mobile step.", + "description": "The parameters of a mobile step.", + "properties": { + "check": { + "description": "Type of assertion to apply in an API test.", + "enum": [ + "equals", + "notEquals", + "contains", + "notContains", + "startsWith", + "notStartsWith", + "greater", + "lower", + "greaterEquals", + "lowerEquals", + "matchRegex", + "between", + "isEmpty", + "notIsEmpty" + ], + "type": "string", + "x-enum-varnames": [ + "EQUALS", + "NOT_EQUALS", + "CONTAINS", + "NOT_CONTAINS", + "STARTS_WITH", + "NOT_STARTS_WITH", + "GREATER", + "LOWER", + "GREATER_EQUALS", + "LOWER_EQUALS", + "MATCH_REGEX", + "BETWEEN", + "IS_EMPTY", + "NOT_IS_EMPTY" + ] + }, + "delay": { + "description": "Number of milliseconds to wait between inputs in a `typeText` step type.", + "format": "int64", + "maximum": 5000, + "minimum": 0, + "type": "integer" + }, + "direction": { + "description": "The direction of the scroll for a `scrollToElement` step type.", + "enum": [ + "up", + "down", + "left", + "right" + ], + "type": "string", + "x-enum-varnames": [ + "UP", + "DOWN", + "LEFT", + "RIGHT" + ] + }, + "element": { + "description": "Information about the element used for a step.", + "properties": { + "context": { + "description": "Context of the element.", + "type": "string" + }, + "contextType": { + "description": "Type of the context that the element is in.", + "enum": [ + "native", + "web" + ], + "type": "string", + "x-enum-varnames": [ + "NATIVE", + "WEB" + ] + }, + "elementDescription": { + "description": "Description of the element.", + "type": "string" + }, + "multiLocator": { + "description": "Multi-locator to find the element.", + "type": "object" + }, + "relativePosition": { + "description": "Position of the action relative to the element.", + "properties": { + "x": { + "description": "The `relativePosition` on the `x` axis for the element.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `relativePosition` on the `y` axis for the element.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "textContent": { + "description": "Text content of the element.", + "type": "string" + }, + "userLocator": { + "description": "User locator to find the element.", + "properties": { + "failTestOnCannotLocate": { + "description": "Whether if the the test should fail if the element cannot be found.", + "type": "boolean" + }, + "values": { + "description": "Values of the user locator.", + "items": { + "description": "A single user locator object.", + "properties": { + "type": { + "description": "Type of a user locator.", + "enum": [ + "accessibility-id", + "id", + "ios-predicate-string", + "ios-class-chain", + "xpath" + ], + "type": "string", + "x-enum-varnames": [ + "ACCESSIBILITY_ID", + "ID", + "IOS_PREDICATE_STRING", + "IOS_CLASS_CHAIN", + "XPATH" + ] + }, + "value": { + "description": "Value of a user locator.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "viewName": { + "description": "Name of the view of the element.", + "type": "string" + } + }, + "type": "object" + }, + "enable": { + "description": "Boolean to change the state of the wifi for a `toggleWiFi` step type.", + "type": "boolean" + }, + "maxScrolls": { + "description": "Maximum number of scrolls to do for a `scrollToElement` step type.", + "format": "int64", + "type": "integer" + }, + "positions": { + "description": "List of positions for the `flick` step type. The maximum is 10 flicks per step", + "items": { + "description": "A description of a single position for a `flick` step type.", + "properties": { + "x": { + "description": "The `x` position for the flick.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `y` position for the flick.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "subtestPublicId": { + "description": "Public ID of the test to be played as part of a `playSubTest` step type.", + "type": "string" + }, + "value": { + "description": "Values used in the step. Used in multiple step types.", + "type": "string" + }, + "variable": { + "description": "Variable object for `extractVariable` step type.", + "properties": { + "example": { + "description": "An example for the variable.", + "example": "", + "type": "string" + }, + "name": { + "description": "The variable name.", + "example": "VAR_NAME", + "type": "string" + } + }, + "required": [ + "name", + "example" + ], + "type": "object" + }, + "withEnter": { + "description": "Boolean to indicate if `Enter` should be pressed at the end of the `typeText` step type.", + "type": "boolean" + }, + "x": { + "description": "Amount to scroll by on the `x` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "Amount to scroll by on the `y` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + } + }, "type": "object" }, "publicId": { @@ -510921,6 +511261,527 @@ ] } }, + "required": [ + "name", + "params", + "type" + ], + "type": "object" + }, + "SyntheticsMobileStepParams": { + "description": "The parameters of a mobile step.", + "properties": { + "check": { + "description": "Type of assertion to apply in an API test.", + "enum": [ + "equals", + "notEquals", + "contains", + "notContains", + "startsWith", + "notStartsWith", + "greater", + "lower", + "greaterEquals", + "lowerEquals", + "matchRegex", + "between", + "isEmpty", + "notIsEmpty" + ], + "type": "string", + "x-enum-varnames": [ + "EQUALS", + "NOT_EQUALS", + "CONTAINS", + "NOT_CONTAINS", + "STARTS_WITH", + "NOT_STARTS_WITH", + "GREATER", + "LOWER", + "GREATER_EQUALS", + "LOWER_EQUALS", + "MATCH_REGEX", + "BETWEEN", + "IS_EMPTY", + "NOT_IS_EMPTY" + ] + }, + "delay": { + "description": "Number of milliseconds to wait between inputs in a `typeText` step type.", + "format": "int64", + "maximum": 5000, + "minimum": 0, + "type": "integer" + }, + "direction": { + "description": "The direction of the scroll for a `scrollToElement` step type.", + "enum": [ + "up", + "down", + "left", + "right" + ], + "type": "string", + "x-enum-varnames": [ + "UP", + "DOWN", + "LEFT", + "RIGHT" + ] + }, + "element": { + "description": "Information about the element used for a step.", + "properties": { + "context": { + "description": "Context of the element.", + "type": "string" + }, + "contextType": { + "description": "Type of the context that the element is in.", + "enum": [ + "native", + "web" + ], + "type": "string", + "x-enum-varnames": [ + "NATIVE", + "WEB" + ] + }, + "elementDescription": { + "description": "Description of the element.", + "type": "string" + }, + "multiLocator": { + "description": "Multi-locator to find the element.", + "type": "object" + }, + "relativePosition": { + "description": "Position of the action relative to the element.", + "properties": { + "x": { + "description": "The `relativePosition` on the `x` axis for the element.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `relativePosition` on the `y` axis for the element.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "textContent": { + "description": "Text content of the element.", + "type": "string" + }, + "userLocator": { + "description": "User locator to find the element.", + "properties": { + "failTestOnCannotLocate": { + "description": "Whether if the the test should fail if the element cannot be found.", + "type": "boolean" + }, + "values": { + "description": "Values of the user locator.", + "items": { + "description": "A single user locator object.", + "properties": { + "type": { + "description": "Type of a user locator.", + "enum": [ + "accessibility-id", + "id", + "ios-predicate-string", + "ios-class-chain", + "xpath" + ], + "type": "string", + "x-enum-varnames": [ + "ACCESSIBILITY_ID", + "ID", + "IOS_PREDICATE_STRING", + "IOS_CLASS_CHAIN", + "XPATH" + ] + }, + "value": { + "description": "Value of a user locator.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "viewName": { + "description": "Name of the view of the element.", + "type": "string" + } + }, + "type": "object" + }, + "enable": { + "description": "Boolean to change the state of the wifi for a `toggleWiFi` step type.", + "type": "boolean" + }, + "maxScrolls": { + "description": "Maximum number of scrolls to do for a `scrollToElement` step type.", + "format": "int64", + "type": "integer" + }, + "positions": { + "description": "List of positions for the `flick` step type. The maximum is 10 flicks per step", + "items": { + "description": "A description of a single position for a `flick` step type.", + "properties": { + "x": { + "description": "The `x` position for the flick.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `y` position for the flick.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "subtestPublicId": { + "description": "Public ID of the test to be played as part of a `playSubTest` step type.", + "type": "string" + }, + "value": { + "description": "Values used in the step. Used in multiple step types.", + "type": "string" + }, + "variable": { + "description": "Variable object for `extractVariable` step type.", + "properties": { + "example": { + "description": "An example for the variable.", + "example": "", + "type": "string" + }, + "name": { + "description": "The variable name.", + "example": "VAR_NAME", + "type": "string" + } + }, + "required": [ + "name", + "example" + ], + "type": "object" + }, + "withEnter": { + "description": "Boolean to indicate if `Enter` should be pressed at the end of the `typeText` step type.", + "type": "boolean" + }, + "x": { + "description": "Amount to scroll by on the `x` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "Amount to scroll by on the `y` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "SyntheticsMobileStepParamsDirection": { + "description": "The direction of the scroll for a `scrollToElement` step type.", + "enum": [ + "up", + "down", + "left", + "right" + ], + "type": "string", + "x-enum-varnames": [ + "UP", + "DOWN", + "LEFT", + "RIGHT" + ] + }, + "SyntheticsMobileStepParamsElement": { + "description": "Information about the element used for a step.", + "properties": { + "context": { + "description": "Context of the element.", + "type": "string" + }, + "contextType": { + "description": "Type of the context that the element is in.", + "enum": [ + "native", + "web" + ], + "type": "string", + "x-enum-varnames": [ + "NATIVE", + "WEB" + ] + }, + "elementDescription": { + "description": "Description of the element.", + "type": "string" + }, + "multiLocator": { + "description": "Multi-locator to find the element.", + "type": "object" + }, + "relativePosition": { + "description": "Position of the action relative to the element.", + "properties": { + "x": { + "description": "The `relativePosition` on the `x` axis for the element.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `relativePosition` on the `y` axis for the element.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "textContent": { + "description": "Text content of the element.", + "type": "string" + }, + "userLocator": { + "description": "User locator to find the element.", + "properties": { + "failTestOnCannotLocate": { + "description": "Whether if the the test should fail if the element cannot be found.", + "type": "boolean" + }, + "values": { + "description": "Values of the user locator.", + "items": { + "description": "A single user locator object.", + "properties": { + "type": { + "description": "Type of a user locator.", + "enum": [ + "accessibility-id", + "id", + "ios-predicate-string", + "ios-class-chain", + "xpath" + ], + "type": "string", + "x-enum-varnames": [ + "ACCESSIBILITY_ID", + "ID", + "IOS_PREDICATE_STRING", + "IOS_CLASS_CHAIN", + "XPATH" + ] + }, + "value": { + "description": "Value of a user locator.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "viewName": { + "description": "Name of the view of the element.", + "type": "string" + } + }, + "type": "object" + }, + "SyntheticsMobileStepParamsElementContextType": { + "description": "Type of the context that the element is in.", + "enum": [ + "native", + "web" + ], + "type": "string", + "x-enum-varnames": [ + "NATIVE", + "WEB" + ] + }, + "SyntheticsMobileStepParamsElementRelativePosition": { + "description": "Position of the action relative to the element.", + "properties": { + "x": { + "description": "The `relativePosition` on the `x` axis for the element.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `relativePosition` on the `y` axis for the element.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "SyntheticsMobileStepParamsElementUserLocator": { + "description": "User locator to find the element.", + "properties": { + "failTestOnCannotLocate": { + "description": "Whether if the the test should fail if the element cannot be found.", + "type": "boolean" + }, + "values": { + "description": "Values of the user locator.", + "items": { + "description": "A single user locator object.", + "properties": { + "type": { + "description": "Type of a user locator.", + "enum": [ + "accessibility-id", + "id", + "ios-predicate-string", + "ios-class-chain", + "xpath" + ], + "type": "string", + "x-enum-varnames": [ + "ACCESSIBILITY_ID", + "ID", + "IOS_PREDICATE_STRING", + "IOS_CLASS_CHAIN", + "XPATH" + ] + }, + "value": { + "description": "Value of a user locator.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "SyntheticsMobileStepParamsElementUserLocatorValuesItems": { + "description": "A single user locator object.", + "properties": { + "type": { + "description": "Type of a user locator.", + "enum": [ + "accessibility-id", + "id", + "ios-predicate-string", + "ios-class-chain", + "xpath" + ], + "type": "string", + "x-enum-varnames": [ + "ACCESSIBILITY_ID", + "ID", + "IOS_PREDICATE_STRING", + "IOS_CLASS_CHAIN", + "XPATH" + ] + }, + "value": { + "description": "Value of a user locator.", + "type": "string" + } + }, + "type": "object" + }, + "SyntheticsMobileStepParamsElementUserLocatorValuesItemsType": { + "description": "Type of a user locator.", + "enum": [ + "accessibility-id", + "id", + "ios-predicate-string", + "ios-class-chain", + "xpath" + ], + "type": "string", + "x-enum-varnames": [ + "ACCESSIBILITY_ID", + "ID", + "IOS_PREDICATE_STRING", + "IOS_CLASS_CHAIN", + "XPATH" + ] + }, + "SyntheticsMobileStepParamsPositions": { + "description": "List of positions for the `flick` step type. The maximum is 10 flicks per step", + "items": { + "description": "A description of a single position for a `flick` step type.", + "properties": { + "x": { + "description": "The `x` position for the flick.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `y` position for the flick.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "SyntheticsMobileStepParamsPositionsItems": { + "description": "A description of a single position for a `flick` step type.", + "properties": { + "x": { + "description": "The `x` position for the flick.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `y` position for the flick.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "SyntheticsMobileStepParamsVariable": { + "description": "Variable object for `extractVariable` step type.", + "properties": { + "example": { + "description": "An example for the variable.", + "example": "", + "type": "string" + }, + "name": { + "description": "The variable name.", + "example": "VAR_NAME", + "type": "string" + } + }, + "required": [ + "name", + "example" + ], "type": "object" }, "SyntheticsMobileStepType": { @@ -510973,20 +511834,11 @@ "description": "Configuration object for a Synthetic mobile test.", "properties": { "initialApplicationArguments": { - "description": "Initial application arguments for a mobile test.", - "properties": { - "propertyNames": { - "description": "Name of the property.", - "properties": { - "pattern": { - "description": "The `propertyNames` `pattern`.", - "example": "^(?!_dd).*$", - "type": "string" - } - }, - "type": "object" - } + "additionalProperties": { + "description": "A single application argument.", + "type": "string" }, + "description": "Initial application arguments for a mobile test.", "type": "object" }, "variables": { @@ -511044,7 +511896,7 @@ "type": "object" }, "device_ids": { - "description": "The `SyntheticsMobileTest` `device_ids`.", + "description": "Array with the different device IDs used to run the test.", "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -511073,7 +511925,7 @@ "description": "Object describing the extra options for a Synthetic test.", "properties": { "allowApplicationCrash": { - "description": "The `SyntheticsMobileTestOptions` `allowApplicationCrash`.", + "description": "A boolean to set if an application crash would mark the test as failed.", "type": "boolean" }, "bindings": { @@ -511081,32 +511933,26 @@ "items": { "description": "Objects describing the binding used for a mobile test.", "properties": { - "items": { - "description": "Object describing the binding used for a mobile test.", - "properties": { - "principals": { - "description": "List of principals for a mobile test binding.", - "items": { - "description": "A principal for a mobile test binding.", - "maxLength": 1500, - "type": "string" - }, - "type": "array" - }, - "role": { - "description": "The definition of `SyntheticsMobileTestBindingItemsRole` object.", - "enum": [ - "editor", - "viewer" - ], - "type": "string", - "x-enum-varnames": [ - "EDITOR", - "VIEWER" - ] - } + "principals": { + "description": "List of principals for a mobile test binding.", + "items": { + "description": "A principal for a mobile test binding.", + "maxLength": 1500, + "type": "string" }, - "type": "object" + "type": "array" + }, + "relation": { + "description": "The type of relation for the binding.", + "enum": [ + "editor", + "viewer" + ], + "type": "string", + "x-enum-varnames": [ + "EDITOR", + "VIEWER" + ] } }, "type": "object" @@ -511138,7 +511984,7 @@ "type": "object" }, "defaultStepTimeout": { - "description": "The `SyntheticsMobileTestOptions` `defaultStepTimeout`.", + "description": "The default timeout for steps in the test (in seconds).", "format": "int32", "maximum": 300, "minimum": 1, @@ -511146,6 +511992,9 @@ }, "device_ids": { "description": "For mobile test, array with the different device IDs used to run the test.", + "example": [ + "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16" + ], "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -511154,7 +512003,7 @@ "type": "array" }, "disableAutoAcceptAlert": { - "description": "The `SyntheticsMobileTestOptions` `disableAutoAcceptAlert`.", + "description": "A boolean to disable auto accepting alerts.", "type": "boolean" }, "min_failure_duration": { @@ -511169,11 +512018,13 @@ "properties": { "applicationId": { "description": "Application ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaaa", "maxLength": 1500, "type": "string" }, "referenceId": { "description": "Reference ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaab", "maxLength": 1500, "type": "string" }, @@ -511183,6 +512034,7 @@ "latest", "version" ], + "example": "latest", "type": "string", "x-enum-varnames": [ "LATEST", @@ -511190,6 +512042,11 @@ ] } }, + "required": [ + "applicationId", + "referenceId", + "referenceType" + ], "type": "object" }, "monitor_name": { @@ -511197,14 +512054,14 @@ "type": "string" }, "monitor_options": { - "description": "Object containing the options for a mobile Synthetic test as a monitor\n(for example, renotification).", + "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { "escalation_message": { "description": "Message to include in the escalation notification.", "type": "string" }, "notification_preset_name": { - "description": "The definition of `SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName` object.", + "description": "The name of the preset for the notification for the monitor.", "enum": [ "show_all", "hide_all", @@ -511226,7 +512083,7 @@ "type": "integer" }, "renotify_occurrences": { - "description": "The `SyntheticsMobileTestOptionsMonitorOptions` `renotify_occurrences`.", + "description": "The number of times to renotify if the test is still failing.", "format": "int64", "type": "integer" } @@ -511241,7 +512098,7 @@ "type": "integer" }, "noScreenshot": { - "description": "The `SyntheticsMobileTestOptions` `noScreenshot`.", + "description": "A boolean set to not take a screenshot for the step.", "type": "boolean" }, "restricted_roles": { @@ -511311,6 +512168,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -511321,23 +512183,33 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { "description": "The frequency at which to run the Synthetic test (in seconds).", + "example": 300, "format": "int64", "maximum": 604800, "minimum": 300, "type": "integer" }, "verbosity": { - "description": "The `SyntheticsMobileTestOptions` `verbosity`.", + "description": "The level of verbosity for the mobile test.", "format": "int32", "maximum": 5, "minimum": 0, "type": "integer" } }, + "required": [ + "device_ids", + "tick_every", + "mobileApplication" + ], "type": "object" }, "public_id": { @@ -511378,6 +512250,7 @@ }, "name": { "description": "The name of the step.", + "example": "", "maxLength": 1500, "type": "string" }, @@ -511386,7 +512259,235 @@ "type": "boolean" }, "params": { - "description": "The parameters of the mobile step.", + "description": "The parameters of a mobile step.", + "properties": { + "check": { + "description": "Type of assertion to apply in an API test.", + "enum": [ + "equals", + "notEquals", + "contains", + "notContains", + "startsWith", + "notStartsWith", + "greater", + "lower", + "greaterEquals", + "lowerEquals", + "matchRegex", + "between", + "isEmpty", + "notIsEmpty" + ], + "type": "string", + "x-enum-varnames": [ + "EQUALS", + "NOT_EQUALS", + "CONTAINS", + "NOT_CONTAINS", + "STARTS_WITH", + "NOT_STARTS_WITH", + "GREATER", + "LOWER", + "GREATER_EQUALS", + "LOWER_EQUALS", + "MATCH_REGEX", + "BETWEEN", + "IS_EMPTY", + "NOT_IS_EMPTY" + ] + }, + "delay": { + "description": "Number of milliseconds to wait between inputs in a `typeText` step type.", + "format": "int64", + "maximum": 5000, + "minimum": 0, + "type": "integer" + }, + "direction": { + "description": "The direction of the scroll for a `scrollToElement` step type.", + "enum": [ + "up", + "down", + "left", + "right" + ], + "type": "string", + "x-enum-varnames": [ + "UP", + "DOWN", + "LEFT", + "RIGHT" + ] + }, + "element": { + "description": "Information about the element used for a step.", + "properties": { + "context": { + "description": "Context of the element.", + "type": "string" + }, + "contextType": { + "description": "Type of the context that the element is in.", + "enum": [ + "native", + "web" + ], + "type": "string", + "x-enum-varnames": [ + "NATIVE", + "WEB" + ] + }, + "elementDescription": { + "description": "Description of the element.", + "type": "string" + }, + "multiLocator": { + "description": "Multi-locator to find the element.", + "type": "object" + }, + "relativePosition": { + "description": "Position of the action relative to the element.", + "properties": { + "x": { + "description": "The `relativePosition` on the `x` axis for the element.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `relativePosition` on the `y` axis for the element.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "textContent": { + "description": "Text content of the element.", + "type": "string" + }, + "userLocator": { + "description": "User locator to find the element.", + "properties": { + "failTestOnCannotLocate": { + "description": "Whether if the the test should fail if the element cannot be found.", + "type": "boolean" + }, + "values": { + "description": "Values of the user locator.", + "items": { + "description": "A single user locator object.", + "properties": { + "type": { + "description": "Type of a user locator.", + "enum": [ + "accessibility-id", + "id", + "ios-predicate-string", + "ios-class-chain", + "xpath" + ], + "type": "string", + "x-enum-varnames": [ + "ACCESSIBILITY_ID", + "ID", + "IOS_PREDICATE_STRING", + "IOS_CLASS_CHAIN", + "XPATH" + ] + }, + "value": { + "description": "Value of a user locator.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "viewName": { + "description": "Name of the view of the element.", + "type": "string" + } + }, + "type": "object" + }, + "enable": { + "description": "Boolean to change the state of the wifi for a `toggleWiFi` step type.", + "type": "boolean" + }, + "maxScrolls": { + "description": "Maximum number of scrolls to do for a `scrollToElement` step type.", + "format": "int64", + "type": "integer" + }, + "positions": { + "description": "List of positions for the `flick` step type. The maximum is 10 flicks per step", + "items": { + "description": "A description of a single position for a `flick` step type.", + "properties": { + "x": { + "description": "The `x` position for the flick.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `y` position for the flick.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "subtestPublicId": { + "description": "Public ID of the test to be played as part of a `playSubTest` step type.", + "type": "string" + }, + "value": { + "description": "Values used in the step. Used in multiple step types.", + "type": "string" + }, + "variable": { + "description": "Variable object for `extractVariable` step type.", + "properties": { + "example": { + "description": "An example for the variable.", + "example": "", + "type": "string" + }, + "name": { + "description": "The variable name.", + "example": "VAR_NAME", + "type": "string" + } + }, + "required": [ + "name", + "example" + ], + "type": "object" + }, + "withEnter": { + "description": "Boolean to indicate if `Enter` should be pressed at the end of the `typeText` step type.", + "type": "boolean" + }, + "x": { + "description": "Amount to scroll by on the `x` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "Amount to scroll by on the `y` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + } + }, "type": "object" }, "publicId": { @@ -511443,6 +512544,11 @@ ] } }, + "required": [ + "name", + "params", + "type" + ], "type": "object" }, "type": "array" @@ -511479,129 +512585,15 @@ ], "type": "object" }, - "SyntheticsMobileTestBinding": { - "description": "Objects describing the binding used for a mobile test.", - "properties": { - "items": { - "description": "Object describing the binding used for a mobile test.", - "properties": { - "principals": { - "description": "List of principals for a mobile test binding.", - "items": { - "description": "A principal for a mobile test binding.", - "maxLength": 1500, - "type": "string" - }, - "type": "array" - }, - "role": { - "description": "The definition of `SyntheticsMobileTestBindingItemsRole` object.", - "enum": [ - "editor", - "viewer" - ], - "type": "string", - "x-enum-varnames": [ - "EDITOR", - "VIEWER" - ] - } - }, - "type": "object" - } - }, - "type": "object" - }, - "SyntheticsMobileTestBindingItems": { - "description": "Object describing the binding used for a mobile test.", - "properties": { - "principals": { - "description": "List of principals for a mobile test binding.", - "items": { - "description": "A principal for a mobile test binding.", - "maxLength": 1500, - "type": "string" - }, - "type": "array" - }, - "role": { - "description": "The definition of `SyntheticsMobileTestBindingItemsRole` object.", - "enum": [ - "editor", - "viewer" - ], - "type": "string", - "x-enum-varnames": [ - "EDITOR", - "VIEWER" - ] - } - }, - "type": "object" - }, - "SyntheticsMobileTestBindingItemsRole": { - "description": "The definition of `SyntheticsMobileTestBindingItemsRole` object.", - "enum": [ - "editor", - "viewer" - ], - "type": "string", - "x-enum-varnames": [ - "EDITOR", - "VIEWER" - ] - }, - "SyntheticsMobileTestBindingPrincipals": { - "description": "List of principals for a mobile test binding.", - "items": { - "description": "A principal for a mobile test binding.", - "maxLength": 1500, - "type": "string" - }, - "type": "array" - }, - "SyntheticsMobileTestCiOptions": { - "description": "CI/CD options for a Synthetic test.", - "properties": { - "executionRule": { - "description": "Execution rule for a Synthetic test.", - "enum": [ - "blocking", - "non_blocking", - "skipped" - ], - "example": "blocking", - "type": "string", - "x-enum-varnames": [ - "BLOCKING", - "NON_BLOCKING", - "SKIPPED" - ] - } - }, - "required": [ - "executionRule" - ], - "type": "object" - }, "SyntheticsMobileTestConfig": { "description": "Configuration object for a Synthetic mobile test.", "properties": { "initialApplicationArguments": { - "description": "Initial application arguments for a mobile test.", - "properties": { - "propertyNames": { - "description": "Name of the property.", - "properties": { - "pattern": { - "description": "The `propertyNames` `pattern`.", - "example": "^(?!_dd).*$", - "type": "string" - } - }, - "type": "object" - } + "additionalProperties": { + "description": "A single application argument.", + "type": "string" }, + "description": "Initial application arguments for a mobile test.", "type": "object" }, "variables": { @@ -511659,38 +512651,18 @@ "type": "object" }, "SyntheticsMobileTestInitialApplicationArguments": { - "description": "Initial application arguments for a mobile test.", - "properties": { - "propertyNames": { - "description": "Name of the property.", - "properties": { - "pattern": { - "description": "The `propertyNames` `pattern`.", - "example": "^(?!_dd).*$", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "SyntheticsMobileTestInitialApplicationArgumentsPropertyNames": { - "description": "Name of the property.", - "properties": { - "pattern": { - "description": "The `propertyNames` `pattern`.", - "example": "^(?!_dd).*$", - "type": "string" - } + "additionalProperties": { + "description": "A single application argument.", + "type": "string" }, + "description": "Initial application arguments for a mobile test.", "type": "object" }, "SyntheticsMobileTestOptions": { "description": "Object describing the extra options for a Synthetic test.", "properties": { "allowApplicationCrash": { - "description": "The `SyntheticsMobileTestOptions` `allowApplicationCrash`.", + "description": "A boolean to set if an application crash would mark the test as failed.", "type": "boolean" }, "bindings": { @@ -511698,32 +512670,26 @@ "items": { "description": "Objects describing the binding used for a mobile test.", "properties": { - "items": { - "description": "Object describing the binding used for a mobile test.", - "properties": { - "principals": { - "description": "List of principals for a mobile test binding.", - "items": { - "description": "A principal for a mobile test binding.", - "maxLength": 1500, - "type": "string" - }, - "type": "array" - }, - "role": { - "description": "The definition of `SyntheticsMobileTestBindingItemsRole` object.", - "enum": [ - "editor", - "viewer" - ], - "type": "string", - "x-enum-varnames": [ - "EDITOR", - "VIEWER" - ] - } + "principals": { + "description": "List of principals for a mobile test binding.", + "items": { + "description": "A principal for a mobile test binding.", + "maxLength": 1500, + "type": "string" }, - "type": "object" + "type": "array" + }, + "relation": { + "description": "The type of relation for the binding.", + "enum": [ + "editor", + "viewer" + ], + "type": "string", + "x-enum-varnames": [ + "EDITOR", + "VIEWER" + ] } }, "type": "object" @@ -511755,7 +512721,7 @@ "type": "object" }, "defaultStepTimeout": { - "description": "The `SyntheticsMobileTestOptions` `defaultStepTimeout`.", + "description": "The default timeout for steps in the test (in seconds).", "format": "int32", "maximum": 300, "minimum": 1, @@ -511763,6 +512729,9 @@ }, "device_ids": { "description": "For mobile test, array with the different device IDs used to run the test.", + "example": [ + "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16" + ], "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -511771,7 +512740,7 @@ "type": "array" }, "disableAutoAcceptAlert": { - "description": "The `SyntheticsMobileTestOptions` `disableAutoAcceptAlert`.", + "description": "A boolean to disable auto accepting alerts.", "type": "boolean" }, "min_failure_duration": { @@ -511786,11 +512755,13 @@ "properties": { "applicationId": { "description": "Application ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaaa", "maxLength": 1500, "type": "string" }, "referenceId": { "description": "Reference ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaab", "maxLength": 1500, "type": "string" }, @@ -511800,6 +512771,7 @@ "latest", "version" ], + "example": "latest", "type": "string", "x-enum-varnames": [ "LATEST", @@ -511807,6 +512779,11 @@ ] } }, + "required": [ + "applicationId", + "referenceId", + "referenceType" + ], "type": "object" }, "monitor_name": { @@ -511814,14 +512791,14 @@ "type": "string" }, "monitor_options": { - "description": "Object containing the options for a mobile Synthetic test as a monitor\n(for example, renotification).", + "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { "escalation_message": { "description": "Message to include in the escalation notification.", "type": "string" }, "notification_preset_name": { - "description": "The definition of `SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName` object.", + "description": "The name of the preset for the notification for the monitor.", "enum": [ "show_all", "hide_all", @@ -511843,7 +512820,7 @@ "type": "integer" }, "renotify_occurrences": { - "description": "The `SyntheticsMobileTestOptionsMonitorOptions` `renotify_occurrences`.", + "description": "The number of times to renotify if the test is still failing.", "format": "int64", "type": "integer" } @@ -511858,7 +512835,7 @@ "type": "integer" }, "noScreenshot": { - "description": "The `SyntheticsMobileTestOptions` `noScreenshot`.", + "description": "A boolean set to not take a screenshot for the step.", "type": "boolean" }, "restricted_roles": { @@ -511928,6 +512905,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -511938,77 +512920,34 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { "description": "The frequency at which to run the Synthetic test (in seconds).", + "example": 300, "format": "int64", "maximum": 604800, "minimum": 300, "type": "integer" }, "verbosity": { - "description": "The `SyntheticsMobileTestOptions` `verbosity`.", + "description": "The level of verbosity for the mobile test.", "format": "int32", "maximum": 5, "minimum": 0, "type": "integer" } }, - "type": "object" - }, - "SyntheticsMobileTestOptionsMonitorOptions": { - "description": "Object containing the options for a mobile Synthetic test as a monitor\n(for example, renotification).", - "properties": { - "escalation_message": { - "description": "Message to include in the escalation notification.", - "type": "string" - }, - "notification_preset_name": { - "description": "The definition of `SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName` object.", - "enum": [ - "show_all", - "hide_all", - "hide_query", - "hide_handles" - ], - "type": "string", - "x-enum-varnames": [ - "SHOW_ALL", - "HIDE_ALL", - "HIDE_QUERY", - "HIDE_HANDLES" - ] - }, - "renotify_interval": { - "description": "Time interval before renotifying if the test is still failing\n(in minutes).", - "format": "int64", - "minimum": 0, - "type": "integer" - }, - "renotify_occurrences": { - "description": "The `SyntheticsMobileTestOptionsMonitorOptions` `renotify_occurrences`.", - "format": "int64", - "type": "integer" - } - }, - "type": "object" - }, - "SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName": { - "description": "The definition of `SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName` object.", - "enum": [ - "show_all", - "hide_all", - "hide_query", - "hide_handles" + "required": [ + "device_ids", + "tick_every", + "mobileApplication" ], - "type": "string", - "x-enum-varnames": [ - "SHOW_ALL", - "HIDE_ALL", - "HIDE_QUERY", - "HIDE_HANDLES" - ] + "type": "object" }, "SyntheticsMobileTestType": { "default": "mobile", @@ -512027,11 +512966,13 @@ "properties": { "applicationId": { "description": "Application ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaaa", "maxLength": 1500, "type": "string" }, "referenceId": { "description": "Reference ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaab", "maxLength": 1500, "type": "string" }, @@ -512041,6 +512982,7 @@ "latest", "version" ], + "example": "latest", "type": "string", "x-enum-varnames": [ "LATEST", @@ -512048,6 +512990,11 @@ ] } }, + "required": [ + "applicationId", + "referenceId", + "referenceType" + ], "type": "object" }, "SyntheticsMobileTestsMobileApplicationReferenceType": { @@ -512056,6 +513003,7 @@ "latest", "version" ], + "example": "latest", "type": "string", "x-enum-varnames": [ "LATEST", @@ -513333,6 +514281,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "SyntheticsTestConfig": { @@ -515753,6 +516704,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -515853,11 +516807,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -515971,6 +516950,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -515981,6 +516965,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -516278,6 +517266,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -516378,11 +517369,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -516496,6 +517512,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -516506,6 +517527,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -516535,15 +517560,56 @@ "SyntheticsTestOptionsMonitorOptions": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" }, + "SyntheticsTestOptionsMonitorOptionsNotificationPresetName": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "SyntheticsTestOptionsRetry": { "description": "Object describing the retry strategy to apply to a Synthetic test.", "properties": { @@ -516599,6 +517665,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -516609,6 +517680,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "SyntheticsTestOptionsSchedulingTimeframe": { @@ -516633,6 +517708,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "SyntheticsTestPauseStatus": { @@ -517421,6 +518501,54 @@ "description": "String Port number to use when performing the test. Supports templated variables.", "type": "string" }, + "SyntheticsTestRestrictionPolicyBinding": { + "description": "Objects describing the binding used for a mobile test.", + "properties": { + "principals": { + "description": "List of principals for a mobile test binding.", + "items": { + "description": "A principal for a mobile test binding.", + "maxLength": 1500, + "type": "string" + }, + "type": "array" + }, + "relation": { + "description": "The type of relation for the binding.", + "enum": [ + "editor", + "viewer" + ], + "type": "string", + "x-enum-varnames": [ + "EDITOR", + "VIEWER" + ] + } + }, + "type": "object" + }, + "SyntheticsTestRestrictionPolicyBindingPrincipals": { + "description": "List of principals for a mobile test binding.", + "items": { + "description": "A principal for a mobile test binding.", + "maxLength": 1500, + "type": "string" + }, + "type": "array" + }, + "SyntheticsTestRestrictionPolicyBindingRelation": { + "description": "The type of relation for the binding.", + "enum": [ + "editor", + "viewer" + ], + "type": "string", + "x-enum-varnames": [ + "EDITOR", + "VIEWER" + ] + }, "SyntheticsTestUptime": { "description": "Object containing the uptime for a Synthetic test ID.", "properties": { @@ -1071113,6 +1072241,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1071213,11 +1072344,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1071331,6 +1072487,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1071341,6 +1072502,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1072899,6 +1074064,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1072999,11 +1074167,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1073117,6 +1074310,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1073127,6 +1074325,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1074562,6 +1075764,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1074662,11 +1075867,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1074780,6 +1076010,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1074790,6 +1076025,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1077727,6 +1078966,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1077827,11 +1079069,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1077945,6 +1079212,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1077955,6 +1079227,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1080497,6 +1081773,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1080597,11 +1081876,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1080715,6 +1082019,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1080725,6 +1082034,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1083458,6 +1084771,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1083558,11 +1084874,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1083676,6 +1085017,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1083686,6 +1085032,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1086351,6 +1087701,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1086451,11 +1087804,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1086569,6 +1087947,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1086579,6 +1087962,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1089121,6 +1090508,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1089221,11 +1090611,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1089339,6 +1090754,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1089349,6 +1090769,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1090833,6 +1092257,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1090933,11 +1092360,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1091051,6 +1092503,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1091061,6 +1092518,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1092468,6 +1093929,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1092568,11 +1094032,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1092686,6 +1094175,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1092696,6 +1094190,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1094265,6 +1095763,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1094365,11 +1095866,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1094483,6 +1096009,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1094493,6 +1096024,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1096023,6 +1097558,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1096123,11 +1097661,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1096241,6 +1097804,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1096251,6 +1097819,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1097658,6 +1099230,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1097758,11 +1099333,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1097876,6 +1099476,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1097886,6 +1099491,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1100633,20 +1102242,11 @@ "description": "Configuration object for a Synthetic mobile test.", "properties": { "initialApplicationArguments": { - "description": "Initial application arguments for a mobile test.", - "properties": { - "propertyNames": { - "description": "Name of the property.", - "properties": { - "pattern": { - "description": "The `propertyNames` `pattern`.", - "example": "^(?!_dd).*$", - "type": "string" - } - }, - "type": "object" - } + "additionalProperties": { + "description": "A single application argument.", + "type": "string" }, + "description": "Initial application arguments for a mobile test.", "type": "object" }, "variables": { @@ -1100704,7 +1102304,7 @@ "type": "object" }, "device_ids": { - "description": "The `SyntheticsMobileTest` `device_ids`.", + "description": "Array with the different device IDs used to run the test.", "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -1100733,7 +1102333,7 @@ "description": "Object describing the extra options for a Synthetic test.", "properties": { "allowApplicationCrash": { - "description": "The `SyntheticsMobileTestOptions` `allowApplicationCrash`.", + "description": "A boolean to set if an application crash would mark the test as failed.", "type": "boolean" }, "bindings": { @@ -1100741,32 +1102341,26 @@ "items": { "description": "Objects describing the binding used for a mobile test.", "properties": { - "items": { - "description": "Object describing the binding used for a mobile test.", - "properties": { - "principals": { - "description": "List of principals for a mobile test binding.", - "items": { - "description": "A principal for a mobile test binding.", - "maxLength": 1500, - "type": "string" - }, - "type": "array" - }, - "role": { - "description": "The definition of `SyntheticsMobileTestBindingItemsRole` object.", - "enum": [ - "editor", - "viewer" - ], - "type": "string", - "x-enum-varnames": [ - "EDITOR", - "VIEWER" - ] - } + "principals": { + "description": "List of principals for a mobile test binding.", + "items": { + "description": "A principal for a mobile test binding.", + "maxLength": 1500, + "type": "string" }, - "type": "object" + "type": "array" + }, + "relation": { + "description": "The type of relation for the binding.", + "enum": [ + "editor", + "viewer" + ], + "type": "string", + "x-enum-varnames": [ + "EDITOR", + "VIEWER" + ] } }, "type": "object" @@ -1100798,7 +1102392,7 @@ "type": "object" }, "defaultStepTimeout": { - "description": "The `SyntheticsMobileTestOptions` `defaultStepTimeout`.", + "description": "The default timeout for steps in the test (in seconds).", "format": "int32", "maximum": 300, "minimum": 1, @@ -1100806,6 +1102400,9 @@ }, "device_ids": { "description": "For mobile test, array with the different device IDs used to run the test.", + "example": [ + "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16" + ], "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -1100814,7 +1102411,7 @@ "type": "array" }, "disableAutoAcceptAlert": { - "description": "The `SyntheticsMobileTestOptions` `disableAutoAcceptAlert`.", + "description": "A boolean to disable auto accepting alerts.", "type": "boolean" }, "min_failure_duration": { @@ -1100829,11 +1102426,13 @@ "properties": { "applicationId": { "description": "Application ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaaa", "maxLength": 1500, "type": "string" }, "referenceId": { "description": "Reference ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaab", "maxLength": 1500, "type": "string" }, @@ -1100843,6 +1102442,7 @@ "latest", "version" ], + "example": "latest", "type": "string", "x-enum-varnames": [ "LATEST", @@ -1100850,6 +1102450,11 @@ ] } }, + "required": [ + "applicationId", + "referenceId", + "referenceType" + ], "type": "object" }, "monitor_name": { @@ -1100857,14 +1102462,14 @@ "type": "string" }, "monitor_options": { - "description": "Object containing the options for a mobile Synthetic test as a monitor\n(for example, renotification).", + "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { "escalation_message": { "description": "Message to include in the escalation notification.", "type": "string" }, "notification_preset_name": { - "description": "The definition of `SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName` object.", + "description": "The name of the preset for the notification for the monitor.", "enum": [ "show_all", "hide_all", @@ -1100886,7 +1102491,7 @@ "type": "integer" }, "renotify_occurrences": { - "description": "The `SyntheticsMobileTestOptionsMonitorOptions` `renotify_occurrences`.", + "description": "The number of times to renotify if the test is still failing.", "format": "int64", "type": "integer" } @@ -1100901,7 +1102506,7 @@ "type": "integer" }, "noScreenshot": { - "description": "The `SyntheticsMobileTestOptions` `noScreenshot`.", + "description": "A boolean set to not take a screenshot for the step.", "type": "boolean" }, "restricted_roles": { @@ -1100971,6 +1102576,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1100981,23 +1102591,33 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { "description": "The frequency at which to run the Synthetic test (in seconds).", + "example": 300, "format": "int64", "maximum": 604800, "minimum": 300, "type": "integer" }, "verbosity": { - "description": "The `SyntheticsMobileTestOptions` `verbosity`.", + "description": "The level of verbosity for the mobile test.", "format": "int32", "maximum": 5, "minimum": 0, "type": "integer" } }, + "required": [ + "device_ids", + "tick_every", + "mobileApplication" + ], "type": "object" }, "public_id": { @@ -1101038,6 +1102658,7 @@ }, "name": { "description": "The name of the step.", + "example": "", "maxLength": 1500, "type": "string" }, @@ -1101046,7 +1102667,235 @@ "type": "boolean" }, "params": { - "description": "The parameters of the mobile step.", + "description": "The parameters of a mobile step.", + "properties": { + "check": { + "description": "Type of assertion to apply in an API test.", + "enum": [ + "equals", + "notEquals", + "contains", + "notContains", + "startsWith", + "notStartsWith", + "greater", + "lower", + "greaterEquals", + "lowerEquals", + "matchRegex", + "between", + "isEmpty", + "notIsEmpty" + ], + "type": "string", + "x-enum-varnames": [ + "EQUALS", + "NOT_EQUALS", + "CONTAINS", + "NOT_CONTAINS", + "STARTS_WITH", + "NOT_STARTS_WITH", + "GREATER", + "LOWER", + "GREATER_EQUALS", + "LOWER_EQUALS", + "MATCH_REGEX", + "BETWEEN", + "IS_EMPTY", + "NOT_IS_EMPTY" + ] + }, + "delay": { + "description": "Number of milliseconds to wait between inputs in a `typeText` step type.", + "format": "int64", + "maximum": 5000, + "minimum": 0, + "type": "integer" + }, + "direction": { + "description": "The direction of the scroll for a `scrollToElement` step type.", + "enum": [ + "up", + "down", + "left", + "right" + ], + "type": "string", + "x-enum-varnames": [ + "UP", + "DOWN", + "LEFT", + "RIGHT" + ] + }, + "element": { + "description": "Information about the element used for a step.", + "properties": { + "context": { + "description": "Context of the element.", + "type": "string" + }, + "contextType": { + "description": "Type of the context that the element is in.", + "enum": [ + "native", + "web" + ], + "type": "string", + "x-enum-varnames": [ + "NATIVE", + "WEB" + ] + }, + "elementDescription": { + "description": "Description of the element.", + "type": "string" + }, + "multiLocator": { + "description": "Multi-locator to find the element.", + "type": "object" + }, + "relativePosition": { + "description": "Position of the action relative to the element.", + "properties": { + "x": { + "description": "The `relativePosition` on the `x` axis for the element.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `relativePosition` on the `y` axis for the element.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "textContent": { + "description": "Text content of the element.", + "type": "string" + }, + "userLocator": { + "description": "User locator to find the element.", + "properties": { + "failTestOnCannotLocate": { + "description": "Whether if the the test should fail if the element cannot be found.", + "type": "boolean" + }, + "values": { + "description": "Values of the user locator.", + "items": { + "description": "A single user locator object.", + "properties": { + "type": { + "description": "Type of a user locator.", + "enum": [ + "accessibility-id", + "id", + "ios-predicate-string", + "ios-class-chain", + "xpath" + ], + "type": "string", + "x-enum-varnames": [ + "ACCESSIBILITY_ID", + "ID", + "IOS_PREDICATE_STRING", + "IOS_CLASS_CHAIN", + "XPATH" + ] + }, + "value": { + "description": "Value of a user locator.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "viewName": { + "description": "Name of the view of the element.", + "type": "string" + } + }, + "type": "object" + }, + "enable": { + "description": "Boolean to change the state of the wifi for a `toggleWiFi` step type.", + "type": "boolean" + }, + "maxScrolls": { + "description": "Maximum number of scrolls to do for a `scrollToElement` step type.", + "format": "int64", + "type": "integer" + }, + "positions": { + "description": "List of positions for the `flick` step type. The maximum is 10 flicks per step", + "items": { + "description": "A description of a single position for a `flick` step type.", + "properties": { + "x": { + "description": "The `x` position for the flick.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `y` position for the flick.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "subtestPublicId": { + "description": "Public ID of the test to be played as part of a `playSubTest` step type.", + "type": "string" + }, + "value": { + "description": "Values used in the step. Used in multiple step types.", + "type": "string" + }, + "variable": { + "description": "Variable object for `extractVariable` step type.", + "properties": { + "example": { + "description": "An example for the variable.", + "example": "", + "type": "string" + }, + "name": { + "description": "The variable name.", + "example": "VAR_NAME", + "type": "string" + } + }, + "required": [ + "name", + "example" + ], + "type": "object" + }, + "withEnter": { + "description": "Boolean to indicate if `Enter` should be pressed at the end of the `typeText` step type.", + "type": "boolean" + }, + "x": { + "description": "Amount to scroll by on the `x` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "Amount to scroll by on the `y` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + } + }, "type": "object" }, "publicId": { @@ -1101103,6 +1102952,11 @@ ] } }, + "required": [ + "name", + "params", + "type" + ], "type": "object" }, "type": "array" @@ -1101155,20 +1103009,11 @@ "description": "Configuration object for a Synthetic mobile test.", "properties": { "initialApplicationArguments": { - "description": "Initial application arguments for a mobile test.", - "properties": { - "propertyNames": { - "description": "Name of the property.", - "properties": { - "pattern": { - "description": "The `propertyNames` `pattern`.", - "example": "^(?!_dd).*$", - "type": "string" - } - }, - "type": "object" - } + "additionalProperties": { + "description": "A single application argument.", + "type": "string" }, + "description": "Initial application arguments for a mobile test.", "type": "object" }, "variables": { @@ -1101226,7 +1103071,7 @@ "type": "object" }, "device_ids": { - "description": "The `SyntheticsMobileTest` `device_ids`.", + "description": "Array with the different device IDs used to run the test.", "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -1101255,7 +1103100,7 @@ "description": "Object describing the extra options for a Synthetic test.", "properties": { "allowApplicationCrash": { - "description": "The `SyntheticsMobileTestOptions` `allowApplicationCrash`.", + "description": "A boolean to set if an application crash would mark the test as failed.", "type": "boolean" }, "bindings": { @@ -1101263,32 +1103108,26 @@ "items": { "description": "Objects describing the binding used for a mobile test.", "properties": { - "items": { - "description": "Object describing the binding used for a mobile test.", - "properties": { - "principals": { - "description": "List of principals for a mobile test binding.", - "items": { - "description": "A principal for a mobile test binding.", - "maxLength": 1500, - "type": "string" - }, - "type": "array" - }, - "role": { - "description": "The definition of `SyntheticsMobileTestBindingItemsRole` object.", - "enum": [ - "editor", - "viewer" - ], - "type": "string", - "x-enum-varnames": [ - "EDITOR", - "VIEWER" - ] - } + "principals": { + "description": "List of principals for a mobile test binding.", + "items": { + "description": "A principal for a mobile test binding.", + "maxLength": 1500, + "type": "string" }, - "type": "object" + "type": "array" + }, + "relation": { + "description": "The type of relation for the binding.", + "enum": [ + "editor", + "viewer" + ], + "type": "string", + "x-enum-varnames": [ + "EDITOR", + "VIEWER" + ] } }, "type": "object" @@ -1101320,7 +1103159,7 @@ "type": "object" }, "defaultStepTimeout": { - "description": "The `SyntheticsMobileTestOptions` `defaultStepTimeout`.", + "description": "The default timeout for steps in the test (in seconds).", "format": "int32", "maximum": 300, "minimum": 1, @@ -1101328,6 +1103167,9 @@ }, "device_ids": { "description": "For mobile test, array with the different device IDs used to run the test.", + "example": [ + "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16" + ], "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -1101336,7 +1103178,7 @@ "type": "array" }, "disableAutoAcceptAlert": { - "description": "The `SyntheticsMobileTestOptions` `disableAutoAcceptAlert`.", + "description": "A boolean to disable auto accepting alerts.", "type": "boolean" }, "min_failure_duration": { @@ -1101351,11 +1103193,13 @@ "properties": { "applicationId": { "description": "Application ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaaa", "maxLength": 1500, "type": "string" }, "referenceId": { "description": "Reference ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaab", "maxLength": 1500, "type": "string" }, @@ -1101365,6 +1103209,7 @@ "latest", "version" ], + "example": "latest", "type": "string", "x-enum-varnames": [ "LATEST", @@ -1101372,6 +1103217,11 @@ ] } }, + "required": [ + "applicationId", + "referenceId", + "referenceType" + ], "type": "object" }, "monitor_name": { @@ -1101379,14 +1103229,14 @@ "type": "string" }, "monitor_options": { - "description": "Object containing the options for a mobile Synthetic test as a monitor\n(for example, renotification).", + "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { "escalation_message": { "description": "Message to include in the escalation notification.", "type": "string" }, "notification_preset_name": { - "description": "The definition of `SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName` object.", + "description": "The name of the preset for the notification for the monitor.", "enum": [ "show_all", "hide_all", @@ -1101408,7 +1103258,7 @@ "type": "integer" }, "renotify_occurrences": { - "description": "The `SyntheticsMobileTestOptionsMonitorOptions` `renotify_occurrences`.", + "description": "The number of times to renotify if the test is still failing.", "format": "int64", "type": "integer" } @@ -1101423,7 +1103273,7 @@ "type": "integer" }, "noScreenshot": { - "description": "The `SyntheticsMobileTestOptions` `noScreenshot`.", + "description": "A boolean set to not take a screenshot for the step.", "type": "boolean" }, "restricted_roles": { @@ -1101493,6 +1103343,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1101503,23 +1103358,33 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { "description": "The frequency at which to run the Synthetic test (in seconds).", + "example": 300, "format": "int64", "maximum": 604800, "minimum": 300, "type": "integer" }, "verbosity": { - "description": "The `SyntheticsMobileTestOptions` `verbosity`.", + "description": "The level of verbosity for the mobile test.", "format": "int32", "maximum": 5, "minimum": 0, "type": "integer" } }, + "required": [ + "device_ids", + "tick_every", + "mobileApplication" + ], "type": "object" }, "public_id": { @@ -1101560,6 +1103425,7 @@ }, "name": { "description": "The name of the step.", + "example": "", "maxLength": 1500, "type": "string" }, @@ -1101568,7 +1103434,235 @@ "type": "boolean" }, "params": { - "description": "The parameters of the mobile step.", + "description": "The parameters of a mobile step.", + "properties": { + "check": { + "description": "Type of assertion to apply in an API test.", + "enum": [ + "equals", + "notEquals", + "contains", + "notContains", + "startsWith", + "notStartsWith", + "greater", + "lower", + "greaterEquals", + "lowerEquals", + "matchRegex", + "between", + "isEmpty", + "notIsEmpty" + ], + "type": "string", + "x-enum-varnames": [ + "EQUALS", + "NOT_EQUALS", + "CONTAINS", + "NOT_CONTAINS", + "STARTS_WITH", + "NOT_STARTS_WITH", + "GREATER", + "LOWER", + "GREATER_EQUALS", + "LOWER_EQUALS", + "MATCH_REGEX", + "BETWEEN", + "IS_EMPTY", + "NOT_IS_EMPTY" + ] + }, + "delay": { + "description": "Number of milliseconds to wait between inputs in a `typeText` step type.", + "format": "int64", + "maximum": 5000, + "minimum": 0, + "type": "integer" + }, + "direction": { + "description": "The direction of the scroll for a `scrollToElement` step type.", + "enum": [ + "up", + "down", + "left", + "right" + ], + "type": "string", + "x-enum-varnames": [ + "UP", + "DOWN", + "LEFT", + "RIGHT" + ] + }, + "element": { + "description": "Information about the element used for a step.", + "properties": { + "context": { + "description": "Context of the element.", + "type": "string" + }, + "contextType": { + "description": "Type of the context that the element is in.", + "enum": [ + "native", + "web" + ], + "type": "string", + "x-enum-varnames": [ + "NATIVE", + "WEB" + ] + }, + "elementDescription": { + "description": "Description of the element.", + "type": "string" + }, + "multiLocator": { + "description": "Multi-locator to find the element.", + "type": "object" + }, + "relativePosition": { + "description": "Position of the action relative to the element.", + "properties": { + "x": { + "description": "The `relativePosition` on the `x` axis for the element.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `relativePosition` on the `y` axis for the element.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "textContent": { + "description": "Text content of the element.", + "type": "string" + }, + "userLocator": { + "description": "User locator to find the element.", + "properties": { + "failTestOnCannotLocate": { + "description": "Whether if the the test should fail if the element cannot be found.", + "type": "boolean" + }, + "values": { + "description": "Values of the user locator.", + "items": { + "description": "A single user locator object.", + "properties": { + "type": { + "description": "Type of a user locator.", + "enum": [ + "accessibility-id", + "id", + "ios-predicate-string", + "ios-class-chain", + "xpath" + ], + "type": "string", + "x-enum-varnames": [ + "ACCESSIBILITY_ID", + "ID", + "IOS_PREDICATE_STRING", + "IOS_CLASS_CHAIN", + "XPATH" + ] + }, + "value": { + "description": "Value of a user locator.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "viewName": { + "description": "Name of the view of the element.", + "type": "string" + } + }, + "type": "object" + }, + "enable": { + "description": "Boolean to change the state of the wifi for a `toggleWiFi` step type.", + "type": "boolean" + }, + "maxScrolls": { + "description": "Maximum number of scrolls to do for a `scrollToElement` step type.", + "format": "int64", + "type": "integer" + }, + "positions": { + "description": "List of positions for the `flick` step type. The maximum is 10 flicks per step", + "items": { + "description": "A description of a single position for a `flick` step type.", + "properties": { + "x": { + "description": "The `x` position for the flick.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `y` position for the flick.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "subtestPublicId": { + "description": "Public ID of the test to be played as part of a `playSubTest` step type.", + "type": "string" + }, + "value": { + "description": "Values used in the step. Used in multiple step types.", + "type": "string" + }, + "variable": { + "description": "Variable object for `extractVariable` step type.", + "properties": { + "example": { + "description": "An example for the variable.", + "example": "", + "type": "string" + }, + "name": { + "description": "The variable name.", + "example": "VAR_NAME", + "type": "string" + } + }, + "required": [ + "name", + "example" + ], + "type": "object" + }, + "withEnter": { + "description": "Boolean to indicate if `Enter` should be pressed at the end of the `typeText` step type.", + "type": "boolean" + }, + "x": { + "description": "Amount to scroll by on the `x` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "Amount to scroll by on the `y` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + } + }, "type": "object" }, "publicId": { @@ -1101625,6 +1103719,11 @@ ] } }, + "required": [ + "name", + "params", + "type" + ], "type": "object" }, "type": "array" @@ -1101844,20 +1103943,11 @@ "description": "Configuration object for a Synthetic mobile test.", "properties": { "initialApplicationArguments": { - "description": "Initial application arguments for a mobile test.", - "properties": { - "propertyNames": { - "description": "Name of the property.", - "properties": { - "pattern": { - "description": "The `propertyNames` `pattern`.", - "example": "^(?!_dd).*$", - "type": "string" - } - }, - "type": "object" - } + "additionalProperties": { + "description": "A single application argument.", + "type": "string" }, + "description": "Initial application arguments for a mobile test.", "type": "object" }, "variables": { @@ -1101915,7 +1104005,7 @@ "type": "object" }, "device_ids": { - "description": "The `SyntheticsMobileTest` `device_ids`.", + "description": "Array with the different device IDs used to run the test.", "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -1101944,7 +1104034,7 @@ "description": "Object describing the extra options for a Synthetic test.", "properties": { "allowApplicationCrash": { - "description": "The `SyntheticsMobileTestOptions` `allowApplicationCrash`.", + "description": "A boolean to set if an application crash would mark the test as failed.", "type": "boolean" }, "bindings": { @@ -1101952,32 +1104042,26 @@ "items": { "description": "Objects describing the binding used for a mobile test.", "properties": { - "items": { - "description": "Object describing the binding used for a mobile test.", - "properties": { - "principals": { - "description": "List of principals for a mobile test binding.", - "items": { - "description": "A principal for a mobile test binding.", - "maxLength": 1500, - "type": "string" - }, - "type": "array" - }, - "role": { - "description": "The definition of `SyntheticsMobileTestBindingItemsRole` object.", - "enum": [ - "editor", - "viewer" - ], - "type": "string", - "x-enum-varnames": [ - "EDITOR", - "VIEWER" - ] - } + "principals": { + "description": "List of principals for a mobile test binding.", + "items": { + "description": "A principal for a mobile test binding.", + "maxLength": 1500, + "type": "string" }, - "type": "object" + "type": "array" + }, + "relation": { + "description": "The type of relation for the binding.", + "enum": [ + "editor", + "viewer" + ], + "type": "string", + "x-enum-varnames": [ + "EDITOR", + "VIEWER" + ] } }, "type": "object" @@ -1102009,7 +1104093,7 @@ "type": "object" }, "defaultStepTimeout": { - "description": "The `SyntheticsMobileTestOptions` `defaultStepTimeout`.", + "description": "The default timeout for steps in the test (in seconds).", "format": "int32", "maximum": 300, "minimum": 1, @@ -1102017,6 +1104101,9 @@ }, "device_ids": { "description": "For mobile test, array with the different device IDs used to run the test.", + "example": [ + "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16" + ], "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -1102025,7 +1104112,7 @@ "type": "array" }, "disableAutoAcceptAlert": { - "description": "The `SyntheticsMobileTestOptions` `disableAutoAcceptAlert`.", + "description": "A boolean to disable auto accepting alerts.", "type": "boolean" }, "min_failure_duration": { @@ -1102040,11 +1104127,13 @@ "properties": { "applicationId": { "description": "Application ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaaa", "maxLength": 1500, "type": "string" }, "referenceId": { "description": "Reference ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaab", "maxLength": 1500, "type": "string" }, @@ -1102054,6 +1104143,7 @@ "latest", "version" ], + "example": "latest", "type": "string", "x-enum-varnames": [ "LATEST", @@ -1102061,6 +1104151,11 @@ ] } }, + "required": [ + "applicationId", + "referenceId", + "referenceType" + ], "type": "object" }, "monitor_name": { @@ -1102068,14 +1104163,14 @@ "type": "string" }, "monitor_options": { - "description": "Object containing the options for a mobile Synthetic test as a monitor\n(for example, renotification).", + "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { "escalation_message": { "description": "Message to include in the escalation notification.", "type": "string" }, "notification_preset_name": { - "description": "The definition of `SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName` object.", + "description": "The name of the preset for the notification for the monitor.", "enum": [ "show_all", "hide_all", @@ -1102097,7 +1104192,7 @@ "type": "integer" }, "renotify_occurrences": { - "description": "The `SyntheticsMobileTestOptionsMonitorOptions` `renotify_occurrences`.", + "description": "The number of times to renotify if the test is still failing.", "format": "int64", "type": "integer" } @@ -1102112,7 +1104207,7 @@ "type": "integer" }, "noScreenshot": { - "description": "The `SyntheticsMobileTestOptions` `noScreenshot`.", + "description": "A boolean set to not take a screenshot for the step.", "type": "boolean" }, "restricted_roles": { @@ -1102182,6 +1104277,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1102192,23 +1104292,33 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { "description": "The frequency at which to run the Synthetic test (in seconds).", + "example": 300, "format": "int64", "maximum": 604800, "minimum": 300, "type": "integer" }, "verbosity": { - "description": "The `SyntheticsMobileTestOptions` `verbosity`.", + "description": "The level of verbosity for the mobile test.", "format": "int32", "maximum": 5, "minimum": 0, "type": "integer" } }, + "required": [ + "device_ids", + "tick_every", + "mobileApplication" + ], "type": "object" }, "public_id": { @@ -1102249,6 +1104359,7 @@ }, "name": { "description": "The name of the step.", + "example": "", "maxLength": 1500, "type": "string" }, @@ -1102257,7 +1104368,235 @@ "type": "boolean" }, "params": { - "description": "The parameters of the mobile step.", + "description": "The parameters of a mobile step.", + "properties": { + "check": { + "description": "Type of assertion to apply in an API test.", + "enum": [ + "equals", + "notEquals", + "contains", + "notContains", + "startsWith", + "notStartsWith", + "greater", + "lower", + "greaterEquals", + "lowerEquals", + "matchRegex", + "between", + "isEmpty", + "notIsEmpty" + ], + "type": "string", + "x-enum-varnames": [ + "EQUALS", + "NOT_EQUALS", + "CONTAINS", + "NOT_CONTAINS", + "STARTS_WITH", + "NOT_STARTS_WITH", + "GREATER", + "LOWER", + "GREATER_EQUALS", + "LOWER_EQUALS", + "MATCH_REGEX", + "BETWEEN", + "IS_EMPTY", + "NOT_IS_EMPTY" + ] + }, + "delay": { + "description": "Number of milliseconds to wait between inputs in a `typeText` step type.", + "format": "int64", + "maximum": 5000, + "minimum": 0, + "type": "integer" + }, + "direction": { + "description": "The direction of the scroll for a `scrollToElement` step type.", + "enum": [ + "up", + "down", + "left", + "right" + ], + "type": "string", + "x-enum-varnames": [ + "UP", + "DOWN", + "LEFT", + "RIGHT" + ] + }, + "element": { + "description": "Information about the element used for a step.", + "properties": { + "context": { + "description": "Context of the element.", + "type": "string" + }, + "contextType": { + "description": "Type of the context that the element is in.", + "enum": [ + "native", + "web" + ], + "type": "string", + "x-enum-varnames": [ + "NATIVE", + "WEB" + ] + }, + "elementDescription": { + "description": "Description of the element.", + "type": "string" + }, + "multiLocator": { + "description": "Multi-locator to find the element.", + "type": "object" + }, + "relativePosition": { + "description": "Position of the action relative to the element.", + "properties": { + "x": { + "description": "The `relativePosition` on the `x` axis for the element.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `relativePosition` on the `y` axis for the element.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "textContent": { + "description": "Text content of the element.", + "type": "string" + }, + "userLocator": { + "description": "User locator to find the element.", + "properties": { + "failTestOnCannotLocate": { + "description": "Whether if the the test should fail if the element cannot be found.", + "type": "boolean" + }, + "values": { + "description": "Values of the user locator.", + "items": { + "description": "A single user locator object.", + "properties": { + "type": { + "description": "Type of a user locator.", + "enum": [ + "accessibility-id", + "id", + "ios-predicate-string", + "ios-class-chain", + "xpath" + ], + "type": "string", + "x-enum-varnames": [ + "ACCESSIBILITY_ID", + "ID", + "IOS_PREDICATE_STRING", + "IOS_CLASS_CHAIN", + "XPATH" + ] + }, + "value": { + "description": "Value of a user locator.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "viewName": { + "description": "Name of the view of the element.", + "type": "string" + } + }, + "type": "object" + }, + "enable": { + "description": "Boolean to change the state of the wifi for a `toggleWiFi` step type.", + "type": "boolean" + }, + "maxScrolls": { + "description": "Maximum number of scrolls to do for a `scrollToElement` step type.", + "format": "int64", + "type": "integer" + }, + "positions": { + "description": "List of positions for the `flick` step type. The maximum is 10 flicks per step", + "items": { + "description": "A description of a single position for a `flick` step type.", + "properties": { + "x": { + "description": "The `x` position for the flick.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `y` position for the flick.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "subtestPublicId": { + "description": "Public ID of the test to be played as part of a `playSubTest` step type.", + "type": "string" + }, + "value": { + "description": "Values used in the step. Used in multiple step types.", + "type": "string" + }, + "variable": { + "description": "Variable object for `extractVariable` step type.", + "properties": { + "example": { + "description": "An example for the variable.", + "example": "", + "type": "string" + }, + "name": { + "description": "The variable name.", + "example": "VAR_NAME", + "type": "string" + } + }, + "required": [ + "name", + "example" + ], + "type": "object" + }, + "withEnter": { + "description": "Boolean to indicate if `Enter` should be pressed at the end of the `typeText` step type.", + "type": "boolean" + }, + "x": { + "description": "Amount to scroll by on the `x` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "Amount to scroll by on the `y` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + } + }, "type": "object" }, "publicId": { @@ -1102314,6 +1104653,11 @@ ] } }, + "required": [ + "name", + "params", + "type" + ], "type": "object" }, "type": "array" @@ -1102483,20 +1104827,11 @@ "description": "Configuration object for a Synthetic mobile test.", "properties": { "initialApplicationArguments": { - "description": "Initial application arguments for a mobile test.", - "properties": { - "propertyNames": { - "description": "Name of the property.", - "properties": { - "pattern": { - "description": "The `propertyNames` `pattern`.", - "example": "^(?!_dd).*$", - "type": "string" - } - }, - "type": "object" - } + "additionalProperties": { + "description": "A single application argument.", + "type": "string" }, + "description": "Initial application arguments for a mobile test.", "type": "object" }, "variables": { @@ -1102554,7 +1104889,7 @@ "type": "object" }, "device_ids": { - "description": "The `SyntheticsMobileTest` `device_ids`.", + "description": "Array with the different device IDs used to run the test.", "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -1102583,7 +1104918,7 @@ "description": "Object describing the extra options for a Synthetic test.", "properties": { "allowApplicationCrash": { - "description": "The `SyntheticsMobileTestOptions` `allowApplicationCrash`.", + "description": "A boolean to set if an application crash would mark the test as failed.", "type": "boolean" }, "bindings": { @@ -1102591,32 +1104926,26 @@ "items": { "description": "Objects describing the binding used for a mobile test.", "properties": { - "items": { - "description": "Object describing the binding used for a mobile test.", - "properties": { - "principals": { - "description": "List of principals for a mobile test binding.", - "items": { - "description": "A principal for a mobile test binding.", - "maxLength": 1500, - "type": "string" - }, - "type": "array" - }, - "role": { - "description": "The definition of `SyntheticsMobileTestBindingItemsRole` object.", - "enum": [ - "editor", - "viewer" - ], - "type": "string", - "x-enum-varnames": [ - "EDITOR", - "VIEWER" - ] - } + "principals": { + "description": "List of principals for a mobile test binding.", + "items": { + "description": "A principal for a mobile test binding.", + "maxLength": 1500, + "type": "string" }, - "type": "object" + "type": "array" + }, + "relation": { + "description": "The type of relation for the binding.", + "enum": [ + "editor", + "viewer" + ], + "type": "string", + "x-enum-varnames": [ + "EDITOR", + "VIEWER" + ] } }, "type": "object" @@ -1102648,7 +1104977,7 @@ "type": "object" }, "defaultStepTimeout": { - "description": "The `SyntheticsMobileTestOptions` `defaultStepTimeout`.", + "description": "The default timeout for steps in the test (in seconds).", "format": "int32", "maximum": 300, "minimum": 1, @@ -1102656,6 +1104985,9 @@ }, "device_ids": { "description": "For mobile test, array with the different device IDs used to run the test.", + "example": [ + "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16" + ], "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -1102664,7 +1104996,7 @@ "type": "array" }, "disableAutoAcceptAlert": { - "description": "The `SyntheticsMobileTestOptions` `disableAutoAcceptAlert`.", + "description": "A boolean to disable auto accepting alerts.", "type": "boolean" }, "min_failure_duration": { @@ -1102679,11 +1105011,13 @@ "properties": { "applicationId": { "description": "Application ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaaa", "maxLength": 1500, "type": "string" }, "referenceId": { "description": "Reference ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaab", "maxLength": 1500, "type": "string" }, @@ -1102693,6 +1105027,7 @@ "latest", "version" ], + "example": "latest", "type": "string", "x-enum-varnames": [ "LATEST", @@ -1102700,6 +1105035,11 @@ ] } }, + "required": [ + "applicationId", + "referenceId", + "referenceType" + ], "type": "object" }, "monitor_name": { @@ -1102707,14 +1105047,14 @@ "type": "string" }, "monitor_options": { - "description": "Object containing the options for a mobile Synthetic test as a monitor\n(for example, renotification).", + "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { "escalation_message": { "description": "Message to include in the escalation notification.", "type": "string" }, "notification_preset_name": { - "description": "The definition of `SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName` object.", + "description": "The name of the preset for the notification for the monitor.", "enum": [ "show_all", "hide_all", @@ -1102736,7 +1105076,7 @@ "type": "integer" }, "renotify_occurrences": { - "description": "The `SyntheticsMobileTestOptionsMonitorOptions` `renotify_occurrences`.", + "description": "The number of times to renotify if the test is still failing.", "format": "int64", "type": "integer" } @@ -1102751,7 +1105091,7 @@ "type": "integer" }, "noScreenshot": { - "description": "The `SyntheticsMobileTestOptions` `noScreenshot`.", + "description": "A boolean set to not take a screenshot for the step.", "type": "boolean" }, "restricted_roles": { @@ -1102821,6 +1105161,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1102831,23 +1105176,33 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { "description": "The frequency at which to run the Synthetic test (in seconds).", + "example": 300, "format": "int64", "maximum": 604800, "minimum": 300, "type": "integer" }, "verbosity": { - "description": "The `SyntheticsMobileTestOptions` `verbosity`.", + "description": "The level of verbosity for the mobile test.", "format": "int32", "maximum": 5, "minimum": 0, "type": "integer" } }, + "required": [ + "device_ids", + "tick_every", + "mobileApplication" + ], "type": "object" }, "public_id": { @@ -1102888,6 +1105243,7 @@ }, "name": { "description": "The name of the step.", + "example": "", "maxLength": 1500, "type": "string" }, @@ -1102896,7 +1105252,235 @@ "type": "boolean" }, "params": { - "description": "The parameters of the mobile step.", + "description": "The parameters of a mobile step.", + "properties": { + "check": { + "description": "Type of assertion to apply in an API test.", + "enum": [ + "equals", + "notEquals", + "contains", + "notContains", + "startsWith", + "notStartsWith", + "greater", + "lower", + "greaterEquals", + "lowerEquals", + "matchRegex", + "between", + "isEmpty", + "notIsEmpty" + ], + "type": "string", + "x-enum-varnames": [ + "EQUALS", + "NOT_EQUALS", + "CONTAINS", + "NOT_CONTAINS", + "STARTS_WITH", + "NOT_STARTS_WITH", + "GREATER", + "LOWER", + "GREATER_EQUALS", + "LOWER_EQUALS", + "MATCH_REGEX", + "BETWEEN", + "IS_EMPTY", + "NOT_IS_EMPTY" + ] + }, + "delay": { + "description": "Number of milliseconds to wait between inputs in a `typeText` step type.", + "format": "int64", + "maximum": 5000, + "minimum": 0, + "type": "integer" + }, + "direction": { + "description": "The direction of the scroll for a `scrollToElement` step type.", + "enum": [ + "up", + "down", + "left", + "right" + ], + "type": "string", + "x-enum-varnames": [ + "UP", + "DOWN", + "LEFT", + "RIGHT" + ] + }, + "element": { + "description": "Information about the element used for a step.", + "properties": { + "context": { + "description": "Context of the element.", + "type": "string" + }, + "contextType": { + "description": "Type of the context that the element is in.", + "enum": [ + "native", + "web" + ], + "type": "string", + "x-enum-varnames": [ + "NATIVE", + "WEB" + ] + }, + "elementDescription": { + "description": "Description of the element.", + "type": "string" + }, + "multiLocator": { + "description": "Multi-locator to find the element.", + "type": "object" + }, + "relativePosition": { + "description": "Position of the action relative to the element.", + "properties": { + "x": { + "description": "The `relativePosition` on the `x` axis for the element.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `relativePosition` on the `y` axis for the element.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "textContent": { + "description": "Text content of the element.", + "type": "string" + }, + "userLocator": { + "description": "User locator to find the element.", + "properties": { + "failTestOnCannotLocate": { + "description": "Whether if the the test should fail if the element cannot be found.", + "type": "boolean" + }, + "values": { + "description": "Values of the user locator.", + "items": { + "description": "A single user locator object.", + "properties": { + "type": { + "description": "Type of a user locator.", + "enum": [ + "accessibility-id", + "id", + "ios-predicate-string", + "ios-class-chain", + "xpath" + ], + "type": "string", + "x-enum-varnames": [ + "ACCESSIBILITY_ID", + "ID", + "IOS_PREDICATE_STRING", + "IOS_CLASS_CHAIN", + "XPATH" + ] + }, + "value": { + "description": "Value of a user locator.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "viewName": { + "description": "Name of the view of the element.", + "type": "string" + } + }, + "type": "object" + }, + "enable": { + "description": "Boolean to change the state of the wifi for a `toggleWiFi` step type.", + "type": "boolean" + }, + "maxScrolls": { + "description": "Maximum number of scrolls to do for a `scrollToElement` step type.", + "format": "int64", + "type": "integer" + }, + "positions": { + "description": "List of positions for the `flick` step type. The maximum is 10 flicks per step", + "items": { + "description": "A description of a single position for a `flick` step type.", + "properties": { + "x": { + "description": "The `x` position for the flick.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `y` position for the flick.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "subtestPublicId": { + "description": "Public ID of the test to be played as part of a `playSubTest` step type.", + "type": "string" + }, + "value": { + "description": "Values used in the step. Used in multiple step types.", + "type": "string" + }, + "variable": { + "description": "Variable object for `extractVariable` step type.", + "properties": { + "example": { + "description": "An example for the variable.", + "example": "", + "type": "string" + }, + "name": { + "description": "The variable name.", + "example": "VAR_NAME", + "type": "string" + } + }, + "required": [ + "name", + "example" + ], + "type": "object" + }, + "withEnter": { + "description": "Boolean to indicate if `Enter` should be pressed at the end of the `typeText` step type.", + "type": "boolean" + }, + "x": { + "description": "Amount to scroll by on the `x` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "Amount to scroll by on the `y` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + } + }, "type": "object" }, "publicId": { @@ -1102953,6 +1105537,11 @@ ] } }, + "required": [ + "name", + "params", + "type" + ], "type": "object" }, "type": "array" @@ -1103005,20 +1105594,11 @@ "description": "Configuration object for a Synthetic mobile test.", "properties": { "initialApplicationArguments": { - "description": "Initial application arguments for a mobile test.", - "properties": { - "propertyNames": { - "description": "Name of the property.", - "properties": { - "pattern": { - "description": "The `propertyNames` `pattern`.", - "example": "^(?!_dd).*$", - "type": "string" - } - }, - "type": "object" - } + "additionalProperties": { + "description": "A single application argument.", + "type": "string" }, + "description": "Initial application arguments for a mobile test.", "type": "object" }, "variables": { @@ -1103076,7 +1105656,7 @@ "type": "object" }, "device_ids": { - "description": "The `SyntheticsMobileTest` `device_ids`.", + "description": "Array with the different device IDs used to run the test.", "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -1103105,7 +1105685,7 @@ "description": "Object describing the extra options for a Synthetic test.", "properties": { "allowApplicationCrash": { - "description": "The `SyntheticsMobileTestOptions` `allowApplicationCrash`.", + "description": "A boolean to set if an application crash would mark the test as failed.", "type": "boolean" }, "bindings": { @@ -1103113,32 +1105693,26 @@ "items": { "description": "Objects describing the binding used for a mobile test.", "properties": { - "items": { - "description": "Object describing the binding used for a mobile test.", - "properties": { - "principals": { - "description": "List of principals for a mobile test binding.", - "items": { - "description": "A principal for a mobile test binding.", - "maxLength": 1500, - "type": "string" - }, - "type": "array" - }, - "role": { - "description": "The definition of `SyntheticsMobileTestBindingItemsRole` object.", - "enum": [ - "editor", - "viewer" - ], - "type": "string", - "x-enum-varnames": [ - "EDITOR", - "VIEWER" - ] - } + "principals": { + "description": "List of principals for a mobile test binding.", + "items": { + "description": "A principal for a mobile test binding.", + "maxLength": 1500, + "type": "string" }, - "type": "object" + "type": "array" + }, + "relation": { + "description": "The type of relation for the binding.", + "enum": [ + "editor", + "viewer" + ], + "type": "string", + "x-enum-varnames": [ + "EDITOR", + "VIEWER" + ] } }, "type": "object" @@ -1103170,7 +1105744,7 @@ "type": "object" }, "defaultStepTimeout": { - "description": "The `SyntheticsMobileTestOptions` `defaultStepTimeout`.", + "description": "The default timeout for steps in the test (in seconds).", "format": "int32", "maximum": 300, "minimum": 1, @@ -1103178,6 +1105752,9 @@ }, "device_ids": { "description": "For mobile test, array with the different device IDs used to run the test.", + "example": [ + "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16" + ], "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -1103186,7 +1105763,7 @@ "type": "array" }, "disableAutoAcceptAlert": { - "description": "The `SyntheticsMobileTestOptions` `disableAutoAcceptAlert`.", + "description": "A boolean to disable auto accepting alerts.", "type": "boolean" }, "min_failure_duration": { @@ -1103201,11 +1105778,13 @@ "properties": { "applicationId": { "description": "Application ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaaa", "maxLength": 1500, "type": "string" }, "referenceId": { "description": "Reference ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaab", "maxLength": 1500, "type": "string" }, @@ -1103215,6 +1105794,7 @@ "latest", "version" ], + "example": "latest", "type": "string", "x-enum-varnames": [ "LATEST", @@ -1103222,6 +1105802,11 @@ ] } }, + "required": [ + "applicationId", + "referenceId", + "referenceType" + ], "type": "object" }, "monitor_name": { @@ -1103229,14 +1105814,14 @@ "type": "string" }, "monitor_options": { - "description": "Object containing the options for a mobile Synthetic test as a monitor\n(for example, renotification).", + "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { "escalation_message": { "description": "Message to include in the escalation notification.", "type": "string" }, "notification_preset_name": { - "description": "The definition of `SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName` object.", + "description": "The name of the preset for the notification for the monitor.", "enum": [ "show_all", "hide_all", @@ -1103258,7 +1105843,7 @@ "type": "integer" }, "renotify_occurrences": { - "description": "The `SyntheticsMobileTestOptionsMonitorOptions` `renotify_occurrences`.", + "description": "The number of times to renotify if the test is still failing.", "format": "int64", "type": "integer" } @@ -1103273,7 +1105858,7 @@ "type": "integer" }, "noScreenshot": { - "description": "The `SyntheticsMobileTestOptions` `noScreenshot`.", + "description": "A boolean set to not take a screenshot for the step.", "type": "boolean" }, "restricted_roles": { @@ -1103343,6 +1105928,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1103353,23 +1105943,33 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { "description": "The frequency at which to run the Synthetic test (in seconds).", + "example": 300, "format": "int64", "maximum": 604800, "minimum": 300, "type": "integer" }, "verbosity": { - "description": "The `SyntheticsMobileTestOptions` `verbosity`.", + "description": "The level of verbosity for the mobile test.", "format": "int32", "maximum": 5, "minimum": 0, "type": "integer" } }, + "required": [ + "device_ids", + "tick_every", + "mobileApplication" + ], "type": "object" }, "public_id": { @@ -1103410,6 +1106010,7 @@ }, "name": { "description": "The name of the step.", + "example": "", "maxLength": 1500, "type": "string" }, @@ -1103418,7 +1106019,235 @@ "type": "boolean" }, "params": { - "description": "The parameters of the mobile step.", + "description": "The parameters of a mobile step.", + "properties": { + "check": { + "description": "Type of assertion to apply in an API test.", + "enum": [ + "equals", + "notEquals", + "contains", + "notContains", + "startsWith", + "notStartsWith", + "greater", + "lower", + "greaterEquals", + "lowerEquals", + "matchRegex", + "between", + "isEmpty", + "notIsEmpty" + ], + "type": "string", + "x-enum-varnames": [ + "EQUALS", + "NOT_EQUALS", + "CONTAINS", + "NOT_CONTAINS", + "STARTS_WITH", + "NOT_STARTS_WITH", + "GREATER", + "LOWER", + "GREATER_EQUALS", + "LOWER_EQUALS", + "MATCH_REGEX", + "BETWEEN", + "IS_EMPTY", + "NOT_IS_EMPTY" + ] + }, + "delay": { + "description": "Number of milliseconds to wait between inputs in a `typeText` step type.", + "format": "int64", + "maximum": 5000, + "minimum": 0, + "type": "integer" + }, + "direction": { + "description": "The direction of the scroll for a `scrollToElement` step type.", + "enum": [ + "up", + "down", + "left", + "right" + ], + "type": "string", + "x-enum-varnames": [ + "UP", + "DOWN", + "LEFT", + "RIGHT" + ] + }, + "element": { + "description": "Information about the element used for a step.", + "properties": { + "context": { + "description": "Context of the element.", + "type": "string" + }, + "contextType": { + "description": "Type of the context that the element is in.", + "enum": [ + "native", + "web" + ], + "type": "string", + "x-enum-varnames": [ + "NATIVE", + "WEB" + ] + }, + "elementDescription": { + "description": "Description of the element.", + "type": "string" + }, + "multiLocator": { + "description": "Multi-locator to find the element.", + "type": "object" + }, + "relativePosition": { + "description": "Position of the action relative to the element.", + "properties": { + "x": { + "description": "The `relativePosition` on the `x` axis for the element.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `relativePosition` on the `y` axis for the element.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "textContent": { + "description": "Text content of the element.", + "type": "string" + }, + "userLocator": { + "description": "User locator to find the element.", + "properties": { + "failTestOnCannotLocate": { + "description": "Whether if the the test should fail if the element cannot be found.", + "type": "boolean" + }, + "values": { + "description": "Values of the user locator.", + "items": { + "description": "A single user locator object.", + "properties": { + "type": { + "description": "Type of a user locator.", + "enum": [ + "accessibility-id", + "id", + "ios-predicate-string", + "ios-class-chain", + "xpath" + ], + "type": "string", + "x-enum-varnames": [ + "ACCESSIBILITY_ID", + "ID", + "IOS_PREDICATE_STRING", + "IOS_CLASS_CHAIN", + "XPATH" + ] + }, + "value": { + "description": "Value of a user locator.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "viewName": { + "description": "Name of the view of the element.", + "type": "string" + } + }, + "type": "object" + }, + "enable": { + "description": "Boolean to change the state of the wifi for a `toggleWiFi` step type.", + "type": "boolean" + }, + "maxScrolls": { + "description": "Maximum number of scrolls to do for a `scrollToElement` step type.", + "format": "int64", + "type": "integer" + }, + "positions": { + "description": "List of positions for the `flick` step type. The maximum is 10 flicks per step", + "items": { + "description": "A description of a single position for a `flick` step type.", + "properties": { + "x": { + "description": "The `x` position for the flick.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `y` position for the flick.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "subtestPublicId": { + "description": "Public ID of the test to be played as part of a `playSubTest` step type.", + "type": "string" + }, + "value": { + "description": "Values used in the step. Used in multiple step types.", + "type": "string" + }, + "variable": { + "description": "Variable object for `extractVariable` step type.", + "properties": { + "example": { + "description": "An example for the variable.", + "example": "", + "type": "string" + }, + "name": { + "description": "The variable name.", + "example": "VAR_NAME", + "type": "string" + } + }, + "required": [ + "name", + "example" + ], + "type": "object" + }, + "withEnter": { + "description": "Boolean to indicate if `Enter` should be pressed at the end of the `typeText` step type.", + "type": "boolean" + }, + "x": { + "description": "Amount to scroll by on the `x` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "Amount to scroll by on the `y` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + } + }, "type": "object" }, "publicId": { @@ -1103475,6 +1106304,11 @@ ] } }, + "required": [ + "name", + "params", + "type" + ], "type": "object" }, "type": "array" @@ -1106137,6 +1108971,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1106237,11 +1109074,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1106355,6 +1109217,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1106365,6 +1109232,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1107989,6 +1110860,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1108089,11 +1110963,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1108207,6 +1111106,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1108217,6 +1111121,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1109805,6 +1112713,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1109905,11 +1112816,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1110023,6 +1112959,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1110033,6 +1112974,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1111468,6 +1114413,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1111568,11 +1114516,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1111686,6 +1114659,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1111696,6 +1114674,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { diff --git a/data/api/v1/translate_actions.es.json b/data/api/v1/translate_actions.es.json new file mode 100644 index 0000000000000..d8df2a0e65256 --- /dev/null +++ b/data/api/v1/translate_actions.es.json @@ -0,0 +1,1204 @@ +{ + "GetIPRanges": { + "description": "Obtén información sobre los rangos de IP de Datadog.", + "summary": "Ver una clave de aplicación que pertenece al usuario actual" + }, + "ListAPIKeys": { + "description": "Obtén todas las claves de API disponibles para tu cuenta.", + "summary": "Mostrar todas las claves de API" + }, + "CreateAPIKey": { + "description": "Crea una clave de API con un nombre determinado.", + "summary": "Crear una clave de API", + "request_description": "", + "request_schema_description": "Clave de API Datadog." + }, + "DeleteAPIKey": { + "description": "Elimina una clave de API determinada.", + "summary": "Eliminar una clave de API" + }, + "GetAPIKey": { + "description": "Obtén una clave de API determinada.", + "summary": "Mostrar una clave de API" + }, + "UpdateAPIKey": { + "description": "Edita el nombre de una clave de API.", + "summary": "Editar una clave de API.", + "request_description": "", + "request_schema_description": "Clave de API Datadog." + }, + "ListApplicationKeys": { + "description": "Obtén todas las claves de aplicación disponibles para tu cuenta de Datadog.", + "summary": "Mostrar todas las claves de aplicación" + }, + "CreateApplicationKey": { + "description": "Crea una clave de aplicación con un nombre determinado.", + "summary": "Crear una clave de aplicación", + "request_description": "", + "request_schema_description": "Clave de aplicación con sus metadatos asociados." + }, + "DeleteApplicationKey": { + "description": "Elimina una clave de aplicación determinada.", + "summary": "Eliminar una clave de aplicación" + }, + "GetApplicationKey": { + "description": "Obtén una clave de aplicación determinada.", + "summary": "Recibir una clave de aplicación" + }, + "UpdateApplicationKey": { + "description": "Edita el nombre de una clave de aplicación.", + "summary": "Editar una clave de aplicación.", + "request_description": "", + "request_schema_description": "Clave de aplicación con sus metadatos asociados." + }, + "SubmitServiceCheck": { + "description": "Envía una lista de checks de servicio.\n\n**Notas**:\n- Se requiere una clave de API válida.\n- Los checks de servicio pueden enviarse hasta 10 minutos antes.", + "summary": "Enviar un check de servicio", + "request_description": "Cuerpo de una solicitud de check de servicio.", + "request_schema_description": "Checks de servicio." + }, + "GetDailyCustomReports": { + "description": "Obtén informes diarios personalizados.\n**Nota:** Este endpoint quedará totalmente obsoleto el 1 de diciembre de 2022.\nConsulta la [migración de v1 a v2 de la API de atribución de uso](https://docs.datadoghq.com/account_management/guide/usage-attribution-migration/) para obtener la guía de migración asociada.", + "summary": "Acceder a la lista de informes personalizados diarios disponibles" + }, + "GetSpecifiedDailyCustomReports": { + "description": "Obtén informes diarios personalizados.\n**Nota:** Este endpoint quedará totalmente obsoleto el 1 de diciembre de 2022.\nConsulta la [migración de v1 a v2 de la API de atribución de uso](https://docs.datadoghq.com/account_management/guide/usage-attribution-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener informes diarios personalizados especficos" + }, + "DeleteDashboards": { + "description": "Elimina dashboards utilizando los ID especificados. Si se produce algún fallo, no se eliminará ningún dashboard (no se permite el éxito parcial).", + "summary": "Eliminar dashboards", + "request_description": "Elimina el cuerpo de una solicitud de dashboards.", + "request_schema_description": "Eliminación masiva del cuerpo de una solicitud de dashboards." + }, + "ListDashboards": { + "description": "Obtén todos los dashboards.\n\n**Nota**: Esta consulta sólo devolverá dashboards personalizados o clonados.\nEsta consulta no devolverá dashboards preconfigurados.", + "summary": "Obtener todos los dashboards" + }, + "RestoreDashboards": { + "description": "Restaura dashboards utilizando los ID especificados. Si se produce algún fallo, no se restaurará ningún dashboard (no se permite el éxito parcial).", + "summary": "Restaurar dashboards eliminados", + "request_description": "Restaura el cuerpo de una solicitud de dashboards.", + "request_schema_description": "Restauración del cuerpo de una solicitud de dashboards." + }, + "CreateDashboard": { + "description": "Crea un dashboard utilizando las opciones especificadas. Cuando definas consultas en tus widgets, ten en cuenta qué consultas deben tener los modificadores `as_count()` or `as_rate()` añadidos.\nPara obtener más información sobre estos modificadores, consulta la siguiente [documentación](https://docs.datadoghq.com/developers/metrics/type_modifiers/?tab=count#in-application-modifiers).", + "summary": "Crear un nuevo dashboard", + "request_description": "Crea el cuerpo de una solicitud de dashboards.", + "request_schema_description": "Un dashboard es una herramienta que usa Datadog para hacer un seguimiento, analizar y mostrar\nvisualmente métricas clave de rendimiento, que te permiten monitorizar el estado de tu infraestructura." + }, + "ListDashboardLists": { + "description": "Obtén todas las definiciones existentes de listas de dashboards.", + "summary": "Obtener todas las listas de dashboards " + }, + "CreateDashboardList": { + "description": "Crea una lista de dashboards vacía.", + "summary": "Crear una lista de dashboards", + "request_description": "Crea el cuerpo de una solicitud de lista de dashboards.", + "request_schema_description": "Tus dashboards de Datadog." + }, + "DeleteDashboardList": { + "description": "Elimina una lista de dashboards.", + "summary": "Dashboards" + }, + "GetDashboardList": { + "description": "Recupera una definición de lista de dashboards existentes.", + "summary": "Obtener una lista de dashboards" + }, + "UpdateDashboardList": { + "description": "Actualiza el nombre de una lista de dashboards.", + "summary": "Actualizar una lista de dashboards", + "request_description": "Actualiza el cuerpo de una solicitud de lista de dashboards.", + "request_schema_description": "Tus dashboards de Datadog." + }, + "CreatePublicDashboard": { + "description": "Comparte un dashboard privado específico generando una URL en la que pueda verse públicamente.", + "summary": "Crear un dashboard compartido", + "request_description": "Crea el cuerpo de una solicitud de dashboards compartidos.", + "request_schema_description": "Objeto de metadatos asociado a la forma en que se compartirá un dashboard." + }, + "DeletePublicDashboard": { + "description": "Revoca la URL pública del dashboard (haciéndola privada), asociada al token especificado.", + "summary": "Revocar la URL de un dashboard compartido" + }, + "GetPublicDashboard": { + "description": "Obtén los metadatos de un dashboard compartido, asociados al token especificado.", + "summary": "Obtener un dashboard compartido" + }, + "UpdatePublicDashboard": { + "description": "Actualiza un dashboard compartido asociado al token especificado.", + "summary": "Actualizar un dashboard compartido", + "request_description": "Actualiza el cuerpo de una solicitud de dashboards.", + "request_schema_description": "Actualiza la configuración de un dashboard compartido." + }, + "DeletePublicDashboardInvitation": { + "description": "Revoca los correos electrónicos de invitación enviados anteriormente y las sesiones activas utilizadas para acceder a un dashboard determinado para direcciones de correo electrónico específicas.", + "summary": "Revocar invitaciones de dashboard compartido", + "request_description": "Cuerpo de una solicitud de eliminación de una invitación de dashboard compartido.", + "request_schema_description": "Datos y metadatos de invitaciones existentes para un dashboard compartido devuelto por la API." + }, + "GetPublicDashboardInvitations": { + "description": "Describe las invitaciones existentes para el dashboard compartido (paginado).", + "summary": "Obtener todas las invitaciones para un dashboard compartido" + }, + "SendPublicDashboardInvitation": { + "description": "Envía correos electrónicos a direcciones especificadas que contengan enlaces para acceder a un determinado dashboard compartido. Las direcciones de correo electrónico ya deben pertenecer a la lista de compartidos autenticada del dashboard compartido.", + "summary": "Enviar correos electrónicos de invitación al dashboard compartido", + "request_description": "Cuerpo de una solicitud de invitación al dashboard compartido.", + "request_schema_description": "Datos y metadatos de invitaciones existentes para un dashboard compartido devuelto por la API." + }, + "DeleteDashboard": { + "description": "Elimina un dashboard utilizando el ID especificado.", + "summary": "Eliminar un dashboard" + }, + "GetDashboard": { + "description": "Obtén un dashboard utilizando el ID especificado.", + "summary": "Obtener un dashboard" + }, + "UpdateDashboard": { + "description": "Actualiza un dashboard utilizando el ID especificado.", + "summary": "Actualizar un dashboard", + "request_description": "Actualiza el cuerpo de una solicitud de dashboard.", + "request_schema_description": "Un dashboard es una herramienta que usa Datadog para hacer un seguimiento, analizar y mostrar\nvisualmente métricas clave de rendimiento, que te permiten monitorizar el estado de tu infraestructura." + }, + "SubmitDistributionPoints": { + "description": "El endpoint de los puntos de distribución te permite publicar datos de distribución que se puedan representar gráficamente en dashboards de Datadog.", + "summary": "Enviar puntos de distribución", + "request_description": "", + "request_schema_description": "Carga útil de los puntos de distribución." + }, + "ListDowntimes": { + "description": "Obtén todos los tiempos de inactividad programados. **Nota:** Este endpoint ha quedado obsoleto. Utiliza endpoints v2.", + "summary": "Obtener todos los tiempos de inactividad" + }, + "CreateDowntime": { + "description": "Programa un tiempo de inactividad. **Nota:** Este endpoint ha quedado obsoleto. Utiliza endpoints v2.", + "summary": "Programar un tiempo de inactividad", + "request_description": "Cuerpo de una solicitud de programación de tiempo de inactividad.", + "request_schema_description": "El tiempo de inactividad te proporciona un mayor control sobre las notificaciones de monitores,\nya que te permite excluir globalmente contextos de alerta.\nLa configuración de tiempos de inactividad, que pueden programarse con horas de inicio y fin,\nevita todas las alertas relacionadas con etiquetas (tags) de Datadog." + }, + "CancelDowntimesByScope": { + "description": "Elimina todos los tiempos de inactividad que coincidan con el contexto de `X`. **Nota:** Esta acción sólo interactúa con los tiempos de inactividad creados con endpoints v1. Este endpoint ha quedado obsoleto y no será reemplazado. Utiliza endpoints v2 para buscar y anular tiempos de inactividad.", + "summary": "Anular tiempos de inactividad por contexto", + "request_description": "Contexto para la anulación de tiempos de inactividad.", + "request_schema_description": "Anula tiempos de inactividad según el contexto." + }, + "CancelDowntime": { + "description": "Anula un tiempo de inactividad. **Nota:** Este endpoint ha quedado obsoleto. Utiliza endpoints v2.", + "summary": "Anular un tiempo de inactividad" + }, + "GetDowntime": { + "description": "Obtén detalles de tiempos de inactividad por `id_de_tiempo_de_inactividad`. **Nota:** Este endpoint ha quedado obsoleto. Utiliza endpoints v2.", + "summary": "Obtener un tiempo de inactividad" + }, + "UpdateDowntime": { + "description": "Actualiza un tiempo de inactividad único por `id_de_tiempo_de_inactividad`. **Nota:** Este endpoint ha quedado obsoleto. Utiliza endpoints v2.", + "summary": "Actualizar un tiempo de inactividad", + "request_description": "Actualiza el cuerpo de una solicitud de tiempo de inactividad.", + "request_schema_description": "El tiempo de inactividad te proporciona un mayor control sobre las notificaciones de monitores,\nya que te permite excluir globalmente contextos de alerta.\nLa configuración de tiempos de inactividad, que pueden programarse con horas de inicio y fin,\nevita todas las alertas relacionadas con etiquetas de Datadog." + }, + "ListEvents": { + "description": "El flujo (stream) de eventos puede consultarse y filtrarse por hora, prioridad, fuentes y etiquetas.\n\n**Notas**:\n- Si el evento que estás consultando contiene un formato markdown de cualquier tipo,\nes posible que aparezcan caracteres como `%`,`\\`,`n` en el resultado.\n\n- Este endpoint devuelve un máximo de `1000` resultados más recientes. Para obtener resultados adicionales,\nidentifica la última marca de tiempo del último resultado y defínela como hora de consulta \"final\" para\npaginar los resultados. También puedes utilizar el parámetro page para especificar qué conjunto de `1000` resultados devolver.", + "summary": "Recibir una lista de eventos" + }, + "CreateEvent": { + "description": "Este endpoint te permite publicar eventos en el flujo.\nEtiquétalos, establece su prioridad y agrégalos con otros eventos.", + "summary": "Publicar un evento", + "request_description": "Objeto de solicitud de evento", + "request_schema_description": "Objeto que representa un evento." + }, + "GetEvent": { + "description": "Este endpoint te permite consultar detalles de eventos.\n\n**Nota**: Si el evento que estás consultando contiene un formato markdown de cualquier tipo,\nes posible que aparezcan caracteres como `%`,`\\`,`n` en el resultado.", + "summary": "Obtener un evento" + }, + "ListEmbeddableGraphs": { + "description": "Obtiene una lista de gráficos previamente creados que se pueden insertar.", + "summary": "Obtener todas las integraciones" + }, + "CreateEmbeddableGraph": { + "description": "Crea un nuevo gráfico integrable.\n\nNota: Si ya existe una integración para la misma consulta exacta en una organización determinada,\nse devuelve la integración más antigua, en lugar de crear una nueva.\n\nSi te interesa utilizar variables de plantilla, consulta\n[Gráficos integrables con variables de plantilla](https://docs.datadoghq.com/dashboards/FAQ/embeddable-graphs-with-template-variables).", + "summary": "Buscar eventos", + "request_description": "Cuerpo del gráfico integrable", + "request_schema_description": "Carga útil para crear un nuevo gráfico integrable." + }, + "GetEmbeddableGraph": { + "description": "Obtener el fragmento HTML de un embed generado previamente con `embed_id`.", + "summary": "Eventos" + }, + "EnableEmbeddableGraph": { + "description": "Habilita una integración específica.", + "summary": "Habilitar una integración" + }, + "RevokeEmbeddableGraph": { + "description": "Revoca una integración específica.", + "summary": "Revocar una integración" + }, + "GetGraphSnapshot": { + "description": "Toma snapshots de gráficos.\n**Nota**: Cuando se crea un snapshot, tarda un tiempo en estar disponible.", + "summary": "Tomar snapshots de gráficos" + }, + "MuteHost": { + "description": "Silencia un host. **Nota:** Esta acción crea un [tiempo de inactividad V2](https://docs.datadoghq.com/api/latest/downtimes/#schedule-a-downtime) para el host.", + "summary": "Silenciar un host", + "request_description": "Silencia el cuerpo de una solicitud de host.", + "request_schema_description": "Combinación de parámetros para silenciar un host." + }, + "UnmuteHost": { + "description": "Desactiva el silenciamiento de un host. Este endpoint no recibe argumentos JSON.", + "summary": "Desactivar el silenciamiento de un host" + }, + "ListHosts": { + "description": "Este endpoint permite buscar hosts por nombre, alias o etiqueta.\nLos hosts activos durante las últimas 3 horas se incluyen por defecto.\nEl periodo de conservación es de 7 días.\nLos resultados se paginan con un máximo de 1000 resultados a la vez.", + "summary": "Obtener todos los hosts para tu organización" + }, + "GetHostTotals": { + "description": "Este endpoint devuelve el número total de hosts activos y actuales en tu cuenta de Datadog.\nActivo significa que el host ha informado en la última hora y actual significa que ha informado en las últimas dos horas.", + "summary": "Obtener el número total de hosts activos" + }, + "DeleteAWSAccount": { + "description": "Elimina una integración AWS en Datadog que coincida con los parámetros especificados `id_de_cuenta` y `nombre_de_rol`.", + "summary": "Eliminar una integración AWS", + "request_description": "Objeto de solicitud de AWS", + "request_schema_description": "Lista de cuentas de AWS a eliminar." + }, + "ListAWSAccounts": { + "description": "Enumera todas las integraciones AWS en Datadog disponibles en tu organización Datadog.", + "summary": "Enumerar todas las integraciones AWS" + }, + "CreateAWSAccount": { + "description": "Crea una integración Amazon Web Services en Datadog.\nEl uso del método `POST` actualiza la configuración de tu integración\nañadiendo tu nueva configuración a la existente en tu organización Datadog.\nÚnico ID de cuenta de AWS para la autenticación basada en roles.", + "summary": "Crear una integración AWS", + "request_description": "Objeto de solicitud de AWS", + "request_schema_description": "Devuelve la cuenta de AWS asociada a esta integración." + }, + "UpdateAWSAccount": { + "description": "Actualiza una integración Amazon Web Services en Datadog.", + "summary": "Actualizar una integración AWS", + "request_description": "Objeto de solicitud de AWS", + "request_schema_description": "Devuelve la cuenta de AWS asociada a esta integración." + }, + "ListAvailableAWSNamespaces": { + "description": "Enumera todas las reglas de espacios de nombres para una determinada integración AWS en Datadog. Este endpoint no recibe argumentos.", + "summary": "Enumerar reglas de espacios de nombres" + }, + "DeleteAWSEventBridgeSource": { + "description": "Elimina una fuente Amazon EventBridge.", + "summary": "Eliminar una fuente Amazon EventBridge", + "request_description": "Elimina la fuente Amazon EventBridge con el nombre, la región y la cuenta de AWS asociados.", + "request_schema_description": "Objeto utilizado para eliminar una fuente EventBridge." + }, + "ListAWSEventBridgeSources": { + "description": "Obtén todas las fuentes Amazon EventBridge.", + "summary": "Obtener todas las fuentes Amazon EventBridge" + }, + "CreateAWSEventBridgeSource": { + "description": "Crea una fuente Amazon EventBridge.", + "summary": "Crear una fuente Amazon EventBridge", + "request_description": "Crea una fuente Amazon EventBridge para una cuenta de AWS con un nombre y una región determinados.", + "request_schema_description": "Objeto utilizado para crear una fuente EventBridge." + }, + "DeleteAWSTagFilter": { + "description": "Elimina una entrada de filtrado por etiquetas.", + "summary": "Eliminar una entrada de filtrado por etiquetas", + "request_description": "Elimina una entrada de filtrado por etiquetas para una cuenta de AWS y un espacio de nombres `dd-aws` determinados.", + "request_schema_description": "Objetos utilizados para eliminar una entrada de filtrado por etiquetas de AWS." + }, + "ListAWSTagFilters": { + "description": "Obtén todos los filtros de etiquetas de AWS.", + "summary": "Obtener todos los filtros de etiquetas de AWS" + }, + "CreateAWSTagFilter": { + "description": "Define un filtro de etiquetas de AWS.", + "summary": "Definir un filtros de etiquetas de AWS", + "request_description": "Define un filtros de etiquetas de AWS utilizando un `identificador_de_cuenta_de_aws`, un `espacio de nombres` y una cadena de filtrado.\nLas opciones de espacio de nombres son `application_elb`, `elb`, `lambda`, `network_elb`, `rds`, `sqs` y `personalizado`.", + "request_schema_description": "Objetos utilizados para definir una etiqueta de filtrado de AWS." + }, + "CreateNewAWSExternalID": { + "description": "Genera un nuevo ID externo de AWS para un par de ID de cuenta y nombre de rol de AWS.", + "summary": "Generar un nuevo ID externo", + "request_description": "Nombre de tu delegación de roles en Datadog.\nPara obtener más información sobre el nombre de rol de tu cuenta de AWS,\nconsulta la [información de configuración de una integración AWS en Datadog](https://docs.datadoghq.com/integrations/amazon_web_services/#setup).", + "request_schema_description": "Devuelve la cuenta de AWS asociada a esta integración." + }, + "DeleteAWSLambdaARN": { + "description": "Elimina la configuración de logs de AWS en Datadog eliminando el ARN Lambda específico asociado a una cuenta de AWS determinada.", + "summary": "Eliminar una integración de logs de AWS", + "request_description": "Elimina el cuerpo de una solicitud de ARN Lambda en AWS.", + "request_schema_description": "ID de cuenta y Lambda ARN en AWS." + }, + "ListAWSLogsIntegrations": { + "description": "Enumera todas las integraciones de logs de AWS en Datadog, configuradas en tu cuenta de Datadog.", + "summary": "Enumerar todas las integraciones de logs de AWS" + }, + "CreateAWSLambdaARN": { + "description": "Adjunta el ARN Lambda de la función Lambda creada para la recopilación de logs de AWS en Datadog en tu ID de cuenta de AWS para habilitar la recopilación de logs.", + "summary": "Autenticación", + "request_description": "Cuerpo de una solicitud de función Lambda asíncrona para logs de AWS.", + "request_schema_description": "ID de cuenta y Lambda ARN en AWS." + }, + "CheckAWSLogsLambdaAsync": { + "description": "Comprueba si existen permisos para añadir activadores de reenvío de logs para servicios determinados y para la cuenta de AWS. La entrada\nes la misma que para habilitar la recopilación de servicios AWS. Las solicitudes posteriores siempre repetirán lo anterior, por lo que este\nendpoint puede ser sondeado intermitentemente en lugar de bloquearse.\n\n- Devuelve el estado \"creado\" cuando comprueba si la función Lambda existe en la cuenta.\n- Devuelve el estado \"en espera\" mientras realiza la comprobación.\n- Devuelve el estado 'comprobado y ok' si existe la función Lambda.\n- Devuelve el estado \"error\" si no existe la función Lambda.", + "summary": "Comprobar si existe una función AWS Lambda", + "request_description": "Comprueba el cuerpo de una solicitud de función Lambda asíncrona para logs de AWS.", + "request_schema_description": "ID de cuenta y Lambda ARN en AWS." + }, + "ListAWSLogsServices": { + "description": "Obtén la lista de los servicios AWS actuales a los que Datadog ofrece la recopilación automática de logs. Utiliza los ID de servicios devueltos con el parámetro de servicios para el endpoint de recopilación de logs de servicios AWS.", + "summary": "Obtener la lista de los servicios listos para logs de AWS" + }, + "EnableAWSLogServices": { + "description": "Habilita la recopilación automática de logs para una lista de servicios. Debe ejecutarse después de la ejecución `CreateAWSLambdaARN` para guardar la configuración.", + "summary": "Habilitar una integración de logs de AWS", + "request_description": "Habilita el cuerpo de una solicitud de servicios de logs de AWS.", + "request_schema_description": "Lista de los servicios AWS actuales a los que Datadog ofrece la recopilación automática de logs." + }, + "CheckAWSLogsServicesAsync": { + "description": "Comprueba si existen permisos para añadir activadores de reenvío de logs para servicios determinados y para la cuenta de AWS. La entrada es la misma que para `EnableAWSLogServices`.\nde forma asíncrona, para que pueda ser sondeado repetidamente de forma no bloqueante hasta\nque se complete la solicitud asíncrona.\n\n- Devuelve el estado \"creado\" cuando comprueba si existen los permisos\nen la cuenta de AWS.\n- Devuelve el estado \"en espera\" mientras realiza la comprobación.\n- Devuelve el estado 'comprobado y ok' si existe la función Lambda.\n- Devuelve el estado \"error\" si no existe la función Lambda.", + "summary": "Comprobar permisos para servicios de logs", + "request_description": "Comprueba el cuerpo de una solicitud de servicios asíncronos para logs de AWS.", + "request_schema_description": "Lista de los servicios AWS actuales a los que Datadog ofrece la recopilación automática de logs." + }, + "DeleteAzureIntegration": { + "description": "Elimina una integración Azure en Datadog determinada de tu cuenta de AWS.", + "summary": "Añadir elementos a una lista de dashboards.", + "request_description": "Elimina el cuerpo de una solicitud de integración Azure en Datadog determinada.", + "request_schema_description": "Integraciones Azure en Datadog configuradas para tu organización." + }, + "ListAzureIntegration": { + "description": "Enumera todas las integraciones Azure en Datadog, configuradas en tu cuenta de Datadog.", + "summary": "Modificar elementos de una lista de dashboards" + }, + "CreateAzureIntegration": { + "description": "Crea una integración Azure en Datadog.\n\nUtilizando el método `POST` actualiza la configuración de tu integración añadiendo tu nueva\nconfiguración a la que existe en tu organización Datadog.\n\nUtilizando el método `PUT` actualiza la configuración de tu integración reemplazando tu\nconfiguración actual con la nueva, enviada a tu organización Datadog.", + "summary": "Crear una integración Azure", + "request_description": "Crea una integración Azure en Datadog para el cuerpo de una solicitud de tu cuenta de Datadog.", + "request_schema_description": "Integraciones Azure en Datadog configuradas para tu organización." + }, + "UpdateAzureIntegration": { + "description": "Actualizar una integración Azure en Datadog requiere un `nombre_de_inquilino` y un `id_de_cliente` existentes.\nCualquier otro campo suministrado reemplazará los valores existentes. Para reemplazar un `nombre_de_inquilino` y un `id_de_cliente`,\nutiliza un `nuevo_nombre_de_inquilino` y un `nuevo_id_de_cliente`. Para no modificar un campo, no lo incluyas en la carga útil.", + "summary": "Actualizar una integración Azure", + "request_description": "Actualiza el cuerpo de una solicitud de integración Azure en Datadog.", + "request_schema_description": "Integraciones Azure en Datadog configuradas para tu organización." + }, + "UpdateAzureHostFilters": { + "description": "Actualiza la lista definida de filtros de hosts para una determinada integración Azure en Datadog.", + "summary": "Actualizar los filtros de hosts de una integración Azure", + "request_description": "Actualiza el cuerpo de los filtros de hosts de una integración Azure en Datadog.", + "request_schema_description": "Integraciones Azure en Datadog configuradas para tu organización." + }, + "DeleteGCPIntegration": { + "description": "Este endpoint está obsoleto. Utiliza endpoints v2. Elimina una determinada integración GCP en Datadog.", + "summary": "Eliminar una integración GCP ", + "request_description": "Elimina una integración GCP en Datadog determinada.", + "request_schema_description": "Tu cuenta de Google Cloud Platform." + }, + "ListGCPIntegration": { + "description": "Este endpoint está obsoleto. Utiliza endpoints v2. Enumera todas las integraciones GCP en Datadog, configuradas en tu cuenta de Datadog.", + "summary": "Enumerar todas las integraciones GCP" + }, + "CreateGCPIntegration": { + "description": "Este endpoint está obsoleto. Utiliza endpoints v2. Crea una integración GCP en Datadog.", + "summary": "Hosts", + "request_description": "Crea una integración GCP en Datadog.", + "request_schema_description": "Tu cuenta de Google Cloud Platform." + }, + "UpdateGCPIntegration": { + "description": "Este endpoint está obsoleto. Utiliza endpoints v2. Actualiza filtros_de_hosts o el auto_silenciado de integraciones GCP en Datadog.\nSe requiere un `id_de_proyecto` y un `correo_electrónico_de_cliente`, pero estos campos no se pueden actualizar.\nSi necesitas actualizar estos campos, elimínalos y utiliza el endpoint de creación (`POST`).\nLos campos no especificados mantendrán sus valores originales.", + "summary": "Actualizar una integración GCP", + "request_description": "Actualiza una integración GCP en Datadog.", + "request_schema_description": "Tu cuenta de Google Cloud Platform." + }, + "CreatePagerDutyIntegrationService": { + "description": "Crea un nuevo objeto de servicio en la integración PagerDuty.", + "summary": "Crear un objeto de servicio", + "request_description": "Crea un nuevo cuerpo de solicitud de objeto de servicio.", + "request_schema_description": "Servicio PagerDuty, disponible para la integración con Datadog." + }, + "DeletePagerDutyIntegrationService": { + "description": "Elimina un único objeto de servicio en la integración PagerDuty en Datadog.", + "summary": "Eliminar un único objeto de servicio" + }, + "GetPagerDutyIntegrationService": { + "description": "Obtén el nombre de servicio en la integración PagerDuty en Datadog.", + "summary": "Recibir un único objeto de servicio" + }, + "UpdatePagerDutyIntegrationService": { + "description": "Actualiza un único objeto de servicio en la integración PagerDuty en Datadog.", + "summary": "Modificar un único objeto de servicio", + "request_description": "Actualiza un cuerpo de solicitud de objeto de servicio existente.", + "request_schema_description": "Clave de objeto de servicio PagerDuty." + }, + "DeleteSlackIntegration": { + "description": "Elimina una integración Slack en Datadog.", + "summary": "Eliminar una integración Slack" + }, + "GetSlackIntegration": { + "description": "Obtén toda la información sobre tu integración Slack en Datadog.", + "summary": "Obtener información sobre una integración Slack" + }, + "CreateSlackIntegration": { + "description": "Crea una integración Slack en Datadog. Una vez creada, añádele un canal con la opción\n[Añadir canales al endpoint de la integración Slack](https://docs.datadoghq.com/api/?lang=bash#add-channels-to-slack-integration).\n\nEste método actualiza la configuración de tu integración **añadiendo**\ntu nueva configuración a la que ya existe en tu organización Datadog.", + "summary": "Crear una integración Slack", + "request_description": "Crea el cuerpo de una solicitud de integración Slack en Datadog.", + "request_schema_description": "Nueva integración Slack en Datadog." + }, + "UpdateSlackIntegration": { + "description": "Añade canales a tu integración Slack en Datadog actual.\n\nEste método actualiza la configuración de tu integración **reemplazando**\ntu configuración actual con la nueva, enviada a tu organización Datadog.", + "summary": "Añadir canales a una integración Slack", + "request_description": "Actualiza el cuerpo de una solicitud de integración Slack en Datadog existente.", + "request_schema_description": "Configuración de tus canales de Slack." + }, + "GetSlackIntegrationChannels": { + "description": "Obtén una lista de todos los canales configurados para tu integración Slack en Datadog.", + "summary": "Obtener todos los canales de una integración Slack" + }, + "CreateSlackIntegrationChannel": { + "description": "Añade un canal a tu integración Slack en Datadog.", + "summary": "Crear un canal de integración Slack", + "request_description": "Carga útil que describe el canal Slack que se va a crear", + "request_schema_description": "Configuración del canal Slack." + }, + "RemoveSlackIntegrationChannel": { + "description": "Elimina un canal de tu integración Slack en Datadog.", + "summary": "Eliminar un canal de una integración Slack" + }, + "GetSlackIntegrationChannel": { + "description": "Obtén un canal configurado para tu integración Slack en Datadog.", + "summary": "Obtener un canal de una integración Slack" + }, + "UpdateSlackIntegrationChannel": { + "description": "Actualiza un canal utilizado en tu integración Slack en Datadog.", + "summary": "Actualizar un canal de una integración Slack", + "request_description": "Carga útil que describe los campos y valores que deben actualizarse.", + "request_schema_description": "Configuración del canal Slack." + }, + "CreateWebhooksIntegrationCustomVariable": { + "description": "Crea un endpoint con el nombre ``.", + "summary": "Crear una variable personalizada", + "request_description": "Definir el cuerpo de una solicitud de variable personalizada.", + "request_schema_description": "Variable personalizada para una integración de webhooks." + }, + "DeleteWebhooksIntegrationCustomVariable": { + "description": "Elimina el endpoint con el nombre ``.", + "summary": "Eliminar una variable personalizada" + }, + "GetWebhooksIntegrationCustomVariable": { + "description": "Muestra el contenido de la variable personalizada con el nombre ``.\n\nSi la variable personalizada es secreta, el valor no se devuelve en la\ncarga útil de la respuesta.", + "summary": "Obtener una variable personalizada" + }, + "UpdateWebhooksIntegrationCustomVariable": { + "description": "Actualiza el endpoint con el nombre ``.", + "summary": "Actualizar una variable personalizada", + "request_description": "Actualiza el cuerpo de una solicitud de variable personalizada existente.", + "request_schema_description": "Actualiza la solicitud de un objeto variable personalizado.\n\n*Todas las propiedades son opcionales.*" + }, + "CreateWebhooksIntegration": { + "description": "Crea un endpoint con el nombre ``.", + "summary": "Crear una integración de webhooks", + "request_description": "Crea el cuerpo de una solicitud de integración de webhooks.", + "request_schema_description": "Integración de webhooks en Datadog." + }, + "DeleteWebhooksIntegration": { + "description": "Elimina el endpoint con el nombre ``.", + "summary": "Eliminar un webhook" + }, + "GetWebhooksIntegration": { + "description": "Obtiene el contenido del webhook con el nombre ``.", + "summary": "Obtener una integración de webhooks" + }, + "UpdateWebhooksIntegration": { + "description": "Actualiza el endpoint con el nombre ``.", + "summary": "Actualizar un webhook", + "request_description": "Actualiza una integración de webhooks en Datadog existente.", + "request_schema_description": "Solicitud de actualización de un objeto de integración de webhooks.\n\n*Todas las propiedades son opcionales.*" + }, + "ListLogs": { + "description": "El endpoint de listas devuelve los logs que coinciden con una consulta de búsqueda de logs.\n[Los resultados están paginados][1].\n\n**Si estás pensando en archivar los logs de tu organización,\nconsidera utilizar las funciones de archivado de Datadog y no la API de listas de logs.\nConsulta la [documentación sobre archivado de logs de Datadog][2].**\n\n[1]: /logs/guide/collect-multiple-logs-with-pagination\n[2]: https://docs.datadoghq.com/logs/archives", + "summary": "Buscar registros", + "request_description": "Filtro de logs", + "request_schema_description": "Objeto para enviar con la solicitud para recuperar una lista de logs de tu organización." + }, + "GetLogsIndexOrder": { + "description": "Obtén el orden actual de tus índices de logs. Este endpoint no recibe argumentos JSON.", + "summary": "Obtener el orden de los índices" + }, + "UpdateLogsIndexOrder": { + "description": "Este endpoint actualiza el orden de los índices de tu organización.\nDevuelve el objeto de orden de índice enviado en el cuerpo de la solicitud, cuando la solicitud se realiza correctamente.", + "summary": "Actualizar el orden de los índices", + "request_description": "Objeto que contiene la nueva lista ordenada de nombres de índices", + "request_schema_description": "Objeto que contiene la lista ordenada de nombres de índices de logs." + }, + "ListLogIndexes": { + "description": "El objeto Índice describe la configuración de un índice de logs.\nEste endpoint devuelve una matriz de objetos `LogIndex` de tu organización.", + "summary": "Obtener todos los índices" + }, + "CreateLogsIndex": { + "description": "Crea un nuevo índice. Devuelve el objeto Índice enviado en el cuerpo de la solicitud cuando la solicitud se realiza correctamente.", + "summary": "Crear un índice", + "request_description": "Objeto que contiene el nuevo índice.", + "request_schema_description": "Objeto que describe un índice de logs de Datadog." + }, + "GetLogsIndex": { + "description": "Obtén un índice de logs de tu organización. Este endpoint no recibe argumentos JSON.", + "summary": "Obtener un índice" + }, + "UpdateLogsIndex": { + "description": "Actualiza un índice identificado por su nombre.\nDevuelve el objeto Index enviado en el cuerpo de la solicitud, cuando la solicitud se realiza correctamente.\n\nUtilizando el método `PUT` se actualiza la configuración del índice **reemplazando**\ntu configuración actual por la nueva, enviada a tu organización Datadog.", + "summary": "Actualizar un índice", + "request_description": "Objeto que contiene la nueva `LogsIndexUpdateRequest`.", + "request_schema_description": "Objeto para actualizar un índice de logs de Datadog." + }, + "GetLogsPipelineOrder": { + "description": "Obtén el orden actual de tus pipelines.\nEste endpoint no recibe argumentos JSON.", + "summary": "Obtener el orden de los pipelines" + }, + "UpdateLogsPipelineOrder": { + "description": "Actualiza el orden de tus pipelines. Dado que los logs se procesan en secuencias, la reordenación de un pipeline puede cambiar\nla estructura y el contenido de los datos procesados por otros pipelines y sus procesadores.\n\n**Nota**: Utilizando el método `PUT` se actualiza el orden de tus pipelines, reemplazando tu orden actual\npor el nuevo, enviado a tu organización Datadog.", + "summary": "Actualizar el orden de los pipelines", + "request_description": "Objeto que contiene la nueva lista ordenada de los ID de pipelines.", + "request_schema_description": "Objeto que contiene la lista ordenada de los ID de pipelines." + }, + "ListLogsPipelines": { + "description": "Obtén todos los pipelines de tu organización.\nEste endpoint no recibe argumentos JSON.", + "summary": "Métricas" + }, + "CreateLogsPipeline": { + "description": "Crea un pipeline en tu organización.", + "summary": "Crear un pipeline", + "request_description": "Definición del nuevo pipeline.", + "request_schema_description": "Los pipelines y los procesadores operan sobre los logs entrantes,\nanalizándolos y transformándolos en atributos estructurados para facilitar su consulta.\n\n**Nota**: Estos endpoints sólo están disponibles para usuarios administradores.\nAsegúrate de utilizar una clave de aplicación creada por un administrador." + }, + "DeleteLogsPipeline": { + "description": "Elimina un pipeline determinado de tu organización.\nEste endpoint no recibe argumentos JSON.", + "summary": "Eliminar un pipeline" + }, + "GetLogsPipeline": { + "description": "Obtén un pipeline específico de tu organización.\nEste endpoint no recibe argumentos JSON.", + "summary": "Obtener un pipeline" + }, + "UpdateLogsPipeline": { + "description": "Actualiza la configuración de un pipeline determinado para cambiar sus procesadores o su orden.\n\n**Nota**: Utilizando este método, se modifica la configuración de tu pipeline **reemplazando**\nla configuración actual por la nueva, enviada a tu organización Datadog.", + "summary": "Actualizar un pipeline", + "request_description": "Nueva definición del pipeline.", + "request_schema_description": "Los pipelines y los procesadores operan sobre los logs entrantes,\nanalizándolos y transformándolos en atributos estructurados para facilitar su consulta.\n\n**Nota**: Estos endpoints sólo están disponibles para usuarios administradores.\nAsegúrate de utilizar una clave de aplicación creada por un administrador." + }, + "ListActiveMetrics": { + "description": "Obtén la lista de las métricas de informes activas desde un momento dado hasta ahora.", + "summary": "Obtener una lista de métricas activas" + }, + "GetMetricMetadata": { + "description": "Obtén metadatos sobre una métrica específica.", + "summary": "Monitores" + }, + "UpdateMetricMetadata": { + "description": "Edita los metadatos de una métrica específica. Más información sobre [tipos admitidos](https://docs.datadoghq.com/developers/metrics).", + "summary": "Editar los metadatos de una métrica ", + "request_description": "Nuevos metadatos.", + "request_schema_description": "Objeto con todos los metadatos relacionados con métricas." + }, + "ListMonitors": { + "description": "Obtén información detallada sobre el monitor especificado de tu organización.", + "summary": "Obtener todos los detalles de un monitor " + }, + "CreateMonitor": { + "description": "Crea un monitor utilizando las opciones especificadas.\n\n#### Tipos de monitores\n\nTipo de monitor elegido de:\n\n- anomalía: `query alert`\n- APM: `query alert` or `trace-analytics alert`\n- compuesto: `composite`\n- personalizado: `service check`\n- previsión: `query alert`\n- host: `service check`\n- integración: `query alert` or `service check`\n- proceso en directo: `process alert`\n- logs: `log alert`\n- métric:a `query alert`\n- red: `service check`\n- outlier: `query alert`\n- proceso: `service check`\n- rum: `rum alert`\n- SLO: `slo alert`\n- watchdog: `event-v2 alert`\n- evento-v2: `event-v2 alert`\n- auditoría: `audit alert`\n- seguimiento de errores: `error-tracking alert`\n- monitorización de bases de datos: `database-monitoring alert`\n- rendimiento de redes: `network-performance alert`\n- coste de la nube: `cost alert`\n\n**Notas**:\n- Los monitores Synthetic se crean mediante la API Synthetics. Para obtener más información, consulta la documentación de la [API Synthetics](https://docs.datadoghq.com/api/latest/synthetics/).\n- Los monitores de logs requieren una clave de aplicación sin contexto.\n\n#### Tipos de consultas\n\n##### Consulta de alertas de métricas\n\nEjemplo: `time_aggr(time_window):space_aggr:metric{tags} [by {key}] operator #`\n\n- `time_aggr`: avg, sum, max, min, change o pct_change\n- `time_window`: `last_#m` (con `#` entre 1 y 10080 dependiendo del tipo de monitor) o `last_#h`(con`#` entre 1 y 168 dependiendo del tipo de monitor) o `last_1d` o `last_1w`\n- `space_aggr`: avg, sum, min, or max\n- `tags`: una o más etiquetas (separadas por comas) o *\n- `key`: a 'key' en sintaxis de etiqueta key:value; define una alerta individual para cada etiqueta del grupo (alertas múltiples)\n- `operator`: <, <=, >, >=, ==, or !=\n- `#`: número entero o decimal utilizado para definir el umbral\n\nSi estás utilizando el agregador de tiempo `_change_` or `_pct_change_`, utiliza `change_aggr(time_aggr(time_window) en su lugar,\ntimeshift):space_aggr:metric{tags} [by {key}] operator #` con:\n\n- `change_aggr` change, pct_change\n- `time_aggr` avg, sum, max, min [Más información](https://docs.datadoghq.com/monitors/create/types/#define-the-conditions)\n- `time_window` last\\_#m (entre 1 y 2880 dependiendo del tipo de monitor), last\\_#h (entre 1 y 48 dependiendo del tipo de monitor) o last_#d (1 or 2)\n- `timeshift` #m_ago (5, 10, 15 o 30), #h_ago (1, 2 o 4) o 1d_ago\n\nUtiliza esto para crear un monitor de outliers con la siguiente consulta:\n`avg(last_30m):outliers(avg:system.cpu.user{role:es-events-data} por {host}, 'dbscan', 7) > 0`\n\n##### Consulta de checks de servicio\n\nEjemplo: `\"check\".over(tags).last(count).by(group).count_by_status()`\n\n- `check` nombre del check, por ejemplo `datadog.agent.up`\n- `tags` una o más etiquetas entre comillas (separadas por comas) o \"*\". por ejemplo: `.over(\"env:prod\", \"role:db\")`; `over` no puede estar vacío.\n- `count` debe ser mayor o igual que tu umbral máximo (definido en las opciones`). Se limita a 100.\nPor ejemplo, si definiste la notificación de estados 1 crítico, 3 ok y 2 advertencia, `count` debería ser al menos 3.\n- `group` debe especificarse para monitores de checks. La agrupación por cada check ya es explícitamente conocida en algunos checks de servicio.\nPor ejemplo, los monitores de la integración Postgres están etiquetados como `db`, `host` y `port`, y los monitores de redes, como `host`, `instance` y `url`. Para obtener más información, consulta la documentación [Checks de servicios](https://docs.datadoghq.com/api/latest/service-checks/).\n\n##### Consulta de alertas de eventos\n\n**Nota:** La Consulta de alertas de eventos ha sido sustituida por la Consulta de alertas de eventos V2. Para obtener más información, consulta la [guía Migración de eventos](https://docs.datadoghq.com/service_management/events/guides/migrating_to_new_events_features/).\n\n##### Consulta de alertas de eventos V2\n\nEjemplo: `events(query).rollup(rollup_method[, measure]).last(time_window) operator #`\n\n- `query` Consulta de búsqueda que sigue la [sintaxis de búsqueda de logs](https://docs.datadoghq.com/logs/search_syntax/).\n- `rollup_method` Las estadísticas roll-up method - admiten `count`, `avg` y `cardinality`.\n- `measure` Para `avg` y cardinality `rollup_method` - especifica la medida o el nombre de faceta que quieres utilizar.\n- `time_window` #m (entre 1 y 2880), #h (entre 1 y 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- `#` número entero o decimal utilizado para definir el umbral.\n\n##### Consulta de alertas de procesos\n\nEjemplo: `processes(search).over(tags).rollup('count').last(timeframe) operator #`\n\n- `search` Cadena de búsqueda de texto libre para consultar procesos.\nResultados del emparejamiento de procesos coincidentes en la página [Procesos en directo](https://docs.datadoghq.com/infrastructure/process/?tab=linuxwindows).\n- `tags` una o más etiquetas (separadas por comas)\n- `timeframe` periodo de tiempo de los recuentos. Ejemplos: 10m, 4h. Periodos de tiempo compatibles: s, m, h, d\n- `operator` <, <=, >, >=, == o !=\n- `#` número entero o decimal utilizado para definir el umbral\n\n##### Consulta de alertas de logs\n\nEjemplo: `logs(query).index(index_name).rollup(rollup_method[, measure]).last(time_window) operator #`\n\n- `query` Consulta de búsqueda que sigue la [sintaxis de búsqueda de logs](https://docs.datadoghq.com/logs/search_syntax/).\n- `rollup_method` Las estadísticas roll-up method - admiten `count`, `avg` y `cardinality`.\n- `measure` Para `avg` y cardinality `rollup_method` - especifica la medida o el nombre de faceta que quieres utilizar.\n- `time_window` #m (entre 1 y 2880), #h (entre 1 y 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- `#` número entero o decimal utilizado para definir el umbral.\n\n##### Consulta compuesta\n\nEjemplo: `12345 && 67890`, donde `12345` y `67890` son los ID de los monitores no compuestos\n\n* `name` [*required*, *default* = **dynamic, based on query**]: Nombre de la alerta.\n* `message` [*required*, *default* = **dynamic, based on query**]: Mensaje a incluir con las notificaciones de este monitor.\nSe pueden enviar notificaciones por correo electrónico a usuarios específicos utilizando la misma notación '@username' que en los eventos.\n* `tags` [*optional*, *default* = **empty list**]: Lista de etiquetas a asociar con tu monitor.\nAl obtener detalles de monitores a través de la API, utiliza el argumento `monitor_tags` para filtrar los resultados por esas etiquetas.\nSólo está disponible a través de la API y no es visible ni editable en la interfaz de usuario de Datadog.\n\n##### Consulta de alertas de SLOs\n\nEjemplo: `error_budget(\"slo_id\").over(\"time_window\") operator #`\n\n- `slo_id`: El ID alfanumérico del SLO para el que configuras la alerta.\n- `time_window`: La ventana de tiempo del destino del SLO sobre el que quieres generar alertas. Opciones válidas: `7d`, `30d`, `90d`.\n- `operator`: `>=` or `>`\n\n##### Consulta de alertas de auditorías\n\nEjemplo: `audits(query).rollup(rollup_method[, measure]).last(time_window) operator #`\n\n- `query` La consulta de búsqueda que utiliza la [sintaxis de búsqueda de logs](https://docs.datadoghq.com/logs/search_syntax/).\n- `rollup_method` Las estadísticas roll-up method - admite `count`, `avg` y `cardinality`.\n- `measure` Para `avg` y cardinality `rollup_method` - especifica la medida o nombre de la faceta que quieres utilizar.\n- `time_window` #m (entre 1 y 2880), #h (entre 1 y 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- `#` número entero o decimal utilizado para definir el umbral.\n\n##### Consulta de alertas de pipelines CI\n\nEjemplo: `ci-pipelines(query).rollup(rollup_method[, measure]).last(time_window) operator #`\n\n- `query` La consulta de búsqueda que utiliza la [sintaxis de búsqueda de logs](https://docs.datadoghq.com/logs/search_syntax/).\n- `rollup_method` Las estadísticas roll-up method - admite `count`, `avg` y `cardinality`.\n- `measure` Para `avg` y cardinality `rollup_method` - especifica la medida o nombre de la faceta que quieres utilizar.\n- `time_window` #m (entre 1 y 2880), #h (entre 1 y 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- `#` número entero o decimal utilizado para definir el umbral.\n\n##### Consulta de alertas de tests CI\n\nEjemplo: `ci-tests(query).rollup(rollup_method[, measure]).last(time_window) operator #`\n\n- `query` La consulta de búsqueda que utiliza la [sintaxis de búsqueda de logs](https://docs.datadoghq.com/logs/search_syntax/).\n- `rollup_method` Las estadísticas roll-up method - admite `count`, `avg` y `cardinality`.\n- `measure` Para `avg` y cardinality `rollup_method` - especifica la medida o nombre de la faceta que quieres utilizar.\n- `time_window` #m (entre 1 y 2880), #h (entre 1 y 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- `#` número entero o decimal utilizado para definir el umbral.\n\n##### Consulta de alertas de seguimiento de errores\n\nEjemplo (RUM): `error-tracking-rum(query).rollup(rollup_method[, measure]).last(time_window) operator #`\nEjemplo (Trazas (traces) de APM): `error-tracking-traces(query).rollup(rollup_method[, measure]).last(time_window) operator #`\n\n- `query` La consulta de búsqueda que utiliza la [sintaxis de búsqueda de logs](https://docs.datadoghq.com/logs/search_syntax/).\n- `rollup_method` Las estadísticas roll-up method - admite `count`, `avg` y `cardinality`.\n- `measure` Para `avg` y cardinality `rollup_method` - especifica la medida o nombre de la faceta que quieres utilizar.\n- `time_window` #m (entre 1 y 2880), #h (entre 1 y 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- `#` número entero o decimal utilizado para definir el umbral.\n\n**Consulta de alertas de la monitorización de bases de datos**\n\nEjemplo: `database-monitoring(query).rollup(rollup_method[, measure]).last(time_window) operator #`\n\n- `query` La consulta de búsqueda que utiliza la [sintaxis de búsqueda de logs](https://docs.datadoghq.com/logs/search_syntax/).\n- `rollup_method` Las estadísticas roll-up method - admite `count`, `avg` y `cardinality`.\n- `measure` Para `avg` y cardinality `rollup_method` - especifica la medida o nombre de la faceta que quieres utilizar.\n- `time_window` #m (entre 1 y 2880), #h (entre 1 y 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- `#` número entero o decimal utilizado para definir el umbral.\n\n**Consulta de alertas de rendimiento de redes**\n\nEjemplo: `network-performance(query).rollup(rollup_method[, measure]).last(time_window) operator #`\n\n- `query` La consulta de búsqueda que utiliza la [sintaxis de búsqueda de logs](https://docs.datadoghq.com/logs/search_syntax/).\n- `rollup_method` Las estadísticas roll-up method - admite `count`, `avg` y `cardinality`.\n- `measure` Para `avg` y cardinality `rollup_method` - especifica la medida o nombre de la faceta que quieres utilizar.\n- `time_window` #m (entre 1 y 2880), #h (entre 1 y 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n- `#` número entero o decimal utilizado para definir el umbral.", + "summary": "Crear un monitor", + "request_description": "Crea el cuerpo de una solicitud de monitor.", + "request_schema_description": "Objeto que describe un monitor." + }, + "CheckCanDeleteMonitor": { + "description": "Comprueba si se pueden eliminar los monitores determinados.", + "summary": "Notebooks" + }, + "SearchMonitorGroups": { + "description": "Busca y filtra los detalles de tus grupos de monitores.", + "summary": "Búsqueda de grupos de monitores" + }, + "SearchMonitors": { + "description": "Busca y filtra los detalles de tu monitor.", + "summary": "Crear un monitor" + }, + "ValidateMonitor": { + "description": "Confirma el monitor proporcionado en la solicitud.\n\n**Nota**: Los monitores de logs requieren una clave de aplicación sin contexto.", + "summary": "Confirmar un monitor", + "request_description": "Monitorizar el objeto de la solicitud", + "request_schema_description": "Objeto que describe un monitor." + }, + "DeleteMonitor": { + "description": "Eliminar el monitor especificado", + "summary": "Eliminar un monitor" + }, + "GetMonitor": { + "description": "Obtén información detallada sobre el monitor especificado de tu organización.", + "summary": "Obtener información de un monitor" + }, + "UpdateMonitor": { + "description": "Edita el monitor especificado.", + "summary": "Editar un monitor", + "request_description": "Edita el cuerpo de una solicitud de monitor.", + "request_schema_description": "Objeto que describe una solicitud de actualización de un monitor." + }, + "ListMonitorDowntimes": { + "description": "Obtén todos los tiempos de inactividad v1 del monitor especificado. **Nota:** Este endpoint está obsoleto. Utiliza endpoints v2.", + "summary": "Obtener tiempos de inactividad activos de un monitor" + }, + "MuteMonitor": { + "description": "Silencia el monitor especificado.", + "summary": "Silenciar un monitor" + }, + "UnmuteMonitor": { + "description": "Desactiva el silenciamiento del monitor especificado.", + "summary": "Desactivar el silenciamiento de un monitor" + }, + "ValidateExistingMonitor": { + "description": "Confirma el monitor proporcionado en la solicitud.", + "summary": "Confirmar un monitor existente", + "request_description": "Monitorizar el objeto de la solicitud", + "request_schema_description": "Objeto que describe un monitor." + }, + "GetMonthlyCustomReports": { + "description": "Obtén informes mensuales personalizados.\n**Nota:** Este endpoint quedará totalmente obsoleto el 1 de diciembre de 2022.\nConsulta la [migración de v1 a v2 de la API de atribución de uso](https://docs.datadoghq.com/account_management/guide/usage-attribution-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener una lista de los informes personalizados mensuales disponibles" + }, + "GetSpecifiedMonthlyCustomReports": { + "description": "Obtén informes diarios personalizados.\n**Nota:** Este endpoint quedará totalmente obsoleto el 1 de diciembre de 2022.\nConsulta la [migración de v1 a v2 de la API de atribución de uso](https://docs.datadoghq.com/account_management/guide/usage-attribution-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener informes mensuales personalizados" + }, + "ListNotebooks": { + "description": "Obtén todos los notebooks. Esta acción también se puede utilizar para buscar notebooks con una `solicitud` concreta\nen el `nombre` o `gestor` de creadores del notebook.", + "summary": "Obtener todos los notebooks" + }, + "CreateNotebook": { + "description": "Crea un notebook utilizando las opciones especificadas.", + "summary": "Cargar metadatos de IdP", + "request_description": "Descripción JSON del notebook que quieres crear.", + "request_schema_description": "Descripción de una solicitud de creación de notebook." + }, + "DeleteNotebook": { + "description": "Elimina un notebook utilizando el ID especificado.", + "summary": "Organizaciones" + }, + "GetNotebook": { + "description": "Obtén un notebook utilizando el ID de notebook especificado.", + "summary": "Obtener un notebook" + }, + "UpdateNotebook": { + "description": "Actualiza un notebook utilizando el ID especificado.", + "summary": "Actualizar un notebook", + "request_description": "Actualiza el cuerpo de una solicitud de notebook.", + "request_schema_description": "Descripción de una solicitud de actualización de notebook." + }, + "ListOrgs": { + "description": "Este endpoint devuelve datos de nivel superior sobre tu organización.", + "summary": "Ver un único objeto de servicio" + }, + "CreateChildOrg": { + "description": "Crea una organización secundaria.\n\nEste endpoint requiere la función de\n[cuenta multiorganización](https://docs.datadoghq.com/account_management/multi_organization/)\ny debe habilitarse\n[poniéndose en contacto con el servicio de asistencia](https://docs.datadoghq.com/help/).\n\nUna vez creada la nueva organización secundaria, puedes interactuar con ella\nutilizando `org.public_id`, `api_key.key` y\n`application_key.hash` proporcionados en la respuesta.", + "summary": "Modificar un único objeto de servicio", + "request_description": "Objeto de organización que debe crearse", + "request_schema_description": "Objeto que describe una organización a crear." + }, + "GetOrg": { + "description": "Obtén información sobre la organización.", + "summary": "Obtener información sobre la organización" + }, + "UpdateOrg": { + "description": "Actualiza tu organización.", + "summary": "Actualizar tu organización", + "request_description": "", + "request_schema_description": "Crea, edita y gestiona organizaciones." + }, + "DowngradeOrg": { + "description": "Sólo disponible para clientes MSP. Elimina una organización secundaria de la jerarquía de la organización principal y coloca la organización secundaria en un periodo de prueba de 30 días.", + "summary": "Organización Spin-off secundaria" + }, + "UploadIdPForOrg": { + "description": "Existen un par de opciones para actualizar el proveedor de identidad (IdP)\nde tu IdP SAML.\n\n* **Multipart Form-Data**: Publica el archivo de metadatos IdP utilizando un formulario.\n\n* **Cuerpo XML:** Publica el archivo de metadatos IdP como cuerpo de la solicitud.", + "summary": "Cargar metadatos de IdP", + "request_description": "", + "request_schema_description": "Objeto que describe la configuración de IdP." + }, + "QueryMetrics": { + "description": "Consulta puntos de series temporales.", + "summary": "Consultar puntos de series temporales" + }, + "ListMetrics": { + "description": "Busca métricas de las últimas 24 horas en Datadog.", + "summary": "Buscar métricas" + }, + "AddSecurityMonitoringSignalToIncident": { + "description": "Añade una señal de seguridad a un incidente. Esto permite buscar señales por incidente dentro del explorador de señales y ver las señales en la línea de tiempo del incidente.", + "summary": "Añadir una señal de seguridad a un incidente", + "request_description": "Atributos que describen la modificación de la señal.", + "request_schema_description": "Atributos que describen a qué incidente añadir la señal." + }, + "EditSecurityMonitoringSignalAssignee": { + "description": "Modifica el usuario que tiene asignada la evaluación de una señal de seguridad.", + "summary": "Modificar el usuario que tiene asignada la evaluación de una señal de seguridad.", + "request_description": "Atributos que describen la modificación de la señal.", + "request_schema_description": "Atributos que describen una operación de actualización de asignatario a través de una señal de seguridad." + }, + "EditSecurityMonitoringSignalState": { + "description": "Cambia el estado que tiene la evaluación de una señal de seguridad.", + "summary": "Cambiar el estado que tiene la evaluación de una señal de seguridad", + "request_description": "Atributos que describen la modificación de la señal.", + "request_schema_description": "Atributos que describen el cambio de estado de un estado determinado." + }, + "SubmitMetrics": { + "description": "El endpoint de métricas te permite publicar datos de series temporales que pueden representarse gráficamente en dashboards de Datadog.\nEl tamaño máximo de la carga útil es de 3,2 megabytes (3200000 bytes). Las cargas útiles comprimidas deben tener un tamaño descomprimido inferior a 62 megabytes (62914560 bytes).\n\nSi envías métricas directamente a la API Datadog sin utilizar DogStatsD, espera:\n\n- 64 bits para la marca de tiempo\n- 64 bits para el valor\n- 40 bytes para los nombres de métrica \n- 50 bytes para las series temporales\n- La carga útil completa es de aproximadamente 100 bytes. Sin embargo, con la API DogStatsD \nse aplica una compresión, lo que reduce el tamaño de la carga útil.", + "summary": "Enviar métricas", + "request_description": "", + "request_schema_description": "Carga útil de las métricas." + }, + "ListServiceDependencies": { + "description": "Obtén una lista de servicios APM y sus dependencias. Los servicios recuperados son filtrados por entorno y por\netiqueta primaria, si se ha definido una.", + "summary": "Obtener todas las dependencias de servicios APM" + }, + "ListSingleServiceDependencies": { + "description": "Obtén los servicios inmediatamente anteriores y posteriores de un servicio específico .\nLos servicios recuperados son filtrados por entorno y por etiqueta primaria, si se ha definido una.", + "summary": "Obtener una dependencia de servicio APM" + }, + "ListSLOs": { + "description": "Obtén una lista de objetos de objetivos de nivel servicio (SLOs) para tu organización.", + "summary": "Obtener todos los SLOs" + }, + "CreateSLO": { + "description": "Crea un objeto objetivo de nivel servicio (SLO).", + "summary": "Crear un objeto SLO", + "request_description": "Objeto de solicitud de objetivo de nivel de servicio.", + "request_schema_description": "Un objeto de solicitud de objetivo de nivel de servicio incluye un indicador de nivel servicio, umbrales\npara uno o varios periodos de tiempo y metadatos (`nombre`, `descripción`, `etiquetas`, etc.)." + }, + "DeleteSLOTimeframeInBulk": { + "description": "Elimina (o elimina parcialmente) varios objetos de objetivos de nivel servicio.\n\nEste endpoint facilita la eliminación de uno o varios umbrales para uno o varios\nobjetos de objetivos de nivel de servicio. Si se eliminan todos los umbrales, el objeto de objetivos de nivel servicio \ntambién se elimina.", + "summary": "Eliminación masiva de periodos de tiempo de SLOs", + "request_description": "Elimina el cuerpo de una solicitud de varios objetos de objetivos de nivel servicio.", + "request_schema_description": "Una asignación de ID de objeto de objetivos de nivel servicio a matrices de periodos de tiempo,\nque indican los umbrales a eliminar para cada ID." + }, + "CheckCanDeleteSLO": { + "description": "Comprueba si un SLO puede eliminarse de forma segura. Por ejemplo,\nasegúrate de que un SLO puede eliminarse sin interrumpir un dashboard.", + "summary": "Comprobar si los SLOs pueden eliminarse de forma segura" + }, + "ListSLOCorrection": { + "description": "Obtén todas las correcciones del objetivo de nivel de servicio.", + "summary": "Obtener todas las correcciones de SLOs" + }, + "CreateSLOCorrection": { + "description": "Crea la corrección de un SLO.", + "summary": "Crear la corrección de un SLO", + "request_description": "Crear la corrección de un SLO", + "request_schema_description": "Objeto que define una corrección que debe aplicarse a un SLO." + }, + "DeleteSLOCorrection": { + "description": "Elimina permanentemente el objeto de corrección de un SLO especificado.", + "summary": "Eliminar la corrección de un SLO" + }, + "GetSLOCorrection": { + "description": "Obtén la corrección de un SLO.", + "summary": "Obtener la corrección de un SLO" + }, + "UpdateSLOCorrection": { + "description": "Actualiza el objeto de corrección de un SLO especificado.", + "summary": "Actualizar la corrección de un SLO", + "request_description": "Objeto de corrección de un SLO modificado.", + "request_schema_description": "Objeto que define una corrección que debe aplicarse a un SLO." + }, + "SearchSLO": { + "description": "Obtén una lista de objetos de objetivos de nivel servicio para tu organización.", + "summary": "Buscar SLOs" + }, + "DeleteSLO": { + "description": "Elimina permanentemente el objeto de objetivos de nivel de servicio especificado.\n\nSi se utiliza un SLO en un dashboard, el endpoint `DELETE /v1/slo/` devuelve\nun error de conflicto 409 porque se hace referencia al SLO en un dashboard.", + "summary": "Eliminar un SLO" + }, + "GetSLO": { + "description": "Obtén un objeto de objetivos de nivel servicio.", + "summary": "Obtener los datos de un SLO" + }, + "UpdateSLO": { + "description": "Actualiza el objeto de objetivos de nivel de servicio especificado.", + "summary": "Actualizar un SLO", + "request_description": "El objeto de solicitud de objetivos de nivel servicio modificado.", + "request_schema_description": "Un objeto de solicitud de objetivo de nivel de servicio incluye un indicador de nivel servicio, umbrales\npara uno o varios periodos de tiempo y metadatos (`nombre`, `descripción`, `etiquetas`, etc.)." + }, + "GetSLOCorrections": { + "description": "Obtener correcciones aplicadas a un SLO", + "summary": "Obtener correcciones para un SLO" + }, + "GetSLOHistory": { + "description": "Obtén el historial de un SLO específico, independientemente de su tipo de SLO.\n\nLos datos detallados del historial se estructuran según el tipo de datos de origen.\nPor ejemplo, los datos de métricas se incluyen para los SLOs de evento que utilizan\nla fuente de métricas y los tipos de SLOs de monitor incluyen el historial de transición del monitor.\n\n**Nota:** Existen diferentes formatos de respuesta para los SLOs basados en eventos y en el tiempo.\nSe muestran ejemplos de ambos.", + "summary": "Obtener el historial de un SLO" + }, + "GetSyntheticsCIBatch": { + "description": "Obtén los datos actualizados de un lote.", + "summary": "Obtener detalles del lote" + }, + "ListLocations": { + "description": "Obtén la lista de ubicaciones públicas y privadas disponibles para tests Synthetic.\nNo se requieren argumentos.", + "summary": "Obtener todas las localizaciones (públicas y privadas)" + }, + "CreatePrivateLocation": { + "description": "Crea una nueva localización Synthetic privada.", + "summary": "Crear una localización privada", + "request_description": "Detalles de la localización privada a crear.", + "request_schema_description": "Objeto que contiene información sobre la localización privada a crear." + }, + "DeletePrivateLocation": { + "description": "Elimina una localización Synthetic privada.", + "summary": "Eliminar una localización privada" + }, + "GetPrivateLocation": { + "description": "Obtén una localización Synthetic privada.", + "summary": "Obtener una localización privada" + }, + "UpdatePrivateLocation": { + "description": "Modifica una localización Synthetic privada.", + "summary": "Modificar una localización privada", + "request_description": "Detalles de la localización privada a actualizar.", + "request_schema_description": "Objeto que contiene información sobre la localización privada a crear." + }, + "GetSyntheticsDefaultLocations": { + "description": "Obtenga la configuración de localizaciones predeterminadas.", + "summary": "Obtener localizaciones predeterminadas" + }, + "ListTests": { + "description": "Obtén la lista de todos los tests Synthetic.", + "summary": "Obtener la lista de todos los tests Synthetic" + }, + "CreateTest": { + "description": "Este endpoint está obsoleto. Para crear un test, utiliza [Crear un test de API](https://docs.datadoghq.com/api/latest/synthetics/#create-an-api-test), o [Crear un test de navegador](https://docs.datadoghq.com/api/latest/synthetics/#create-a-browser-test).", + "summary": "Crear un test", + "request_description": "Detalles del test a crear.", + "request_schema_description": "Objeto que contiene información sobre tu test Synthetic." + }, + "CreateSyntheticsAPITest": { + "description": "Crea un test de API Synthetic.", + "summary": "Crear un test de API", + "request_description": "Detalles del test a crear.", + "request_schema_description": "Objeto que contiene detalles sobre un test de API Synthetic." + }, + "GetAPITest": { + "description": "Obtén la configuración detallada, asociada a\nun test de API Synthetic.", + "summary": "Obtener un test de API" + }, + "UpdateAPITest": { + "description": "Edita la configuración de un test de API Synthetic.", + "summary": "Editar un test de API", + "request_description": "Nuevos detalles del test a guardar.", + "request_schema_description": "Objeto que contiene detalles sobre un test de API Synthetic." + }, + "CreateSyntheticsBrowserTest": { + "description": "Crea un test de navegador Synthetic.", + "summary": "Crear un test de navegador", + "request_description": "Detalles del test a crear.", + "request_schema_description": "Objeto que contiene detalles sobre un test de navegador Synthetic." + }, + "GetBrowserTest": { + "description": "Obtén la configuración detallada (incluyendo los pasos), asociada a\nun test de navegador Synthetic.", + "summary": "Obtener un test de navegador" + }, + "UpdateBrowserTest": { + "description": "Edita la configuración de un test de navegador Synthetic.", + "summary": "Editar un test de navegador", + "request_description": "Nuevos detalles del test a guardar.", + "request_schema_description": "Objeto que contiene detalles sobre un test de navegador Synthetic." + }, + "GetBrowserTestLatestResults": { + "description": "Obtén los últimos 150 resúmenes de los resultados de un determinado test de navegador Synthetic.", + "summary": "Obtén los resúmenes de los últimos resultados de un test de navegador" + }, + "GetBrowserTestResult": { + "description": "Obtén un resultado completo específico de un test de navegador Synthetic determinado.", + "summary": "Obtener el resultado de un test de navegador" + }, + "DeleteTests": { + "description": "Eliminar varios tests Synthetic por ID.", + "summary": "Eliminar tests", + "request_description": "Lista de ID públicos de los tests Synthetic a eliminar.", + "request_schema_description": "Lista JSON del o los ID de los tests Synthetic que quieres\neliminar." + }, + "CreateSyntheticsMobileTest": { + "description": "Cree un test móvil Synthetic.", + "summary": "Crear un test móvil", + "request_description": "Detalles del test a crear.", + "request_schema_description": "Objeto que contiene detalles sobre un test móvil Synthetic." + }, + "GetMobileTest": { + "description": "Obtén la configuración detallada asociada a\nun test móvil Synthetic.", + "summary": "Obtener un test móvil" + }, + "UpdateMobileTest": { + "description": "Edita la configuración de un test móvil Synthetic.", + "summary": "Editar un test móvil", + "request_description": "Nuevos detalles del test a guardar.", + "request_schema_description": "Objeto que contiene detalles sobre un test móvil Synthetic." + }, + "TriggerTests": { + "description": "Activa un conjunto de tests Synthetic.", + "summary": "Activador de tests Synthetic", + "request_description": "Identificadores de los tests a activar.", + "request_schema_description": "Objeto que describe los tests Synthetic a activar." + }, + "TriggerCITests": { + "description": "Activa un conjunto de tests Synthetic para la integración continua.", + "summary": "Activar tests a partir de procesos CI/CD", + "request_description": "Detalles de los tests a activar.", + "request_schema_description": "Objeto que describe los tests Synthetic a activar." + }, + "FetchUptimes": { + "description": "Obtén el tiempo de actividad de varios tests Synthetic por ID.", + "summary": "Obtener el tiempo de actividad de varios tests", + "request_description": "Lista de ID públicos de los tests Synthetic y los periodos de tiempo.", + "request_schema_description": "Objeto que contiene los ID de los tests Synthetic y un periodo de tiempo." + }, + "GetTest": { + "description": "Obtén la configuración detallada, asociada a un test Synthetic.", + "summary": "Obtener la configuración de un test" + }, + "PatchTest": { + "description": "Parchea la configuración de un test Synthetic con datos parciales.", + "summary": "Parcheo de un test Synthetic", + "request_description": "Lista de operaciones compatible con [parches JSON](https://jsonpatch.com/)", + "request_schema_description": "Envuelve una matriz de operaciones de [parches JSON](https://jsonpatch.com) para realizar en el test" + }, + "UpdateTest": { + "description": "Este endpoint está obsoleto. Para modificar un test, utiliza [Modificar un test de API](https://docs.datadoghq.com/api/latest/synthetics/#edit-an-api-test) o [Editar un test de navegador](https://docs.datadoghq.com/api/latest/synthetics/#edit-a-browser-test).", + "summary": "Editar un test", + "request_description": "Nuevos detalles del test a guardar.", + "request_schema_description": "Objeto que contiene información sobre tu test Synthetic." + }, + "GetAPITestLatestResults": { + "description": "Obtén los últimos 150 resúmenes de los resultados de un determinado test de API Synthetic.", + "summary": "Obtener los resúmenes de los últimos resultados de un test de API" + }, + "GetAPITestResult": { + "description": "Obtén un resultado completo específico de un test de API Synthetic determinado.", + "summary": "Obtener el resultado de un test de API" + }, + "UpdateTestPauseStatus": { + "description": "Pausa o inicia un test Synthetic cambiando el estado.", + "summary": "Pausar o iniciar un test", + "request_description": "Estado en el que se encuentra el test Synthetic.", + "request_schema_description": "Objeto para iniciar o pausar un test Synthetic existente." + }, + "ListGlobalVariables": { + "description": "Obtén la lista de todas las variables globales Synthetic.", + "summary": "Obtener todas las variables globales" + }, + "CreateGlobalVariable": { + "description": "Crea una variable global Synthetic.", + "summary": "Crear una variable global", + "request_description": "Detalles de la variable global a crear.", + "request_schema_description": "Detalles de la variable global a crear." + }, + "DeleteGlobalVariable": { + "description": "Elimina una variable global Synthetic.", + "summary": "Eliminar una variable global" + }, + "GetGlobalVariable": { + "description": "Obtén la configuración detallada de una variable global.", + "summary": "Obtener una variable global" + }, + "EditGlobalVariable": { + "description": "Modifica una variable global Synthetic.", + "summary": "Modificar una variable global", + "request_description": "Detalles de la variable global a actualizar.", + "request_schema_description": "Detalles de la variable global a crear." + }, + "ListHostTags": { + "description": "Devuelve una asignación de etiquetas a hosts para toda tu infraestructura.", + "summary": "Obtener etiquetas" + }, + "DeleteHostTags": { + "description": "Este endpoint te permite eliminar todas las etiquetas asignadas a usuarios\npara un único host.", + "summary": "Eliminar etiquetas de hosts" + }, + "GetHostTags": { + "description": "Devuelve la lista de etiquetas que se aplican a un host determinado.", + "summary": "Obtener etiquetas de hosts" + }, + "CreateHostTags": { + "description": "Este endpoint permite añadir nuevas etiquetas a un host,\nespecificando opcionalmente de dónde proceden estas etiquetas).", + "summary": "Añadir etiquetas a un host", + "request_description": "Actualiza el cuerpo de una solicitud de etiquetas de hosts.", + "request_schema_description": "Conjunto de etiquetas para asociar a tu host." + }, + "UpdateHostTags": { + "description": "Este endpoint te permite actualizar/sustituir todas las etiquetas en\nuna fuente de integraciones con aquellas proporcionadas en la solicitud.", + "summary": "Actualizar etiquetas de hosts", + "request_description": "Añadir etiquetas a hosts", + "request_schema_description": "Conjunto de etiquetas para asociar a tu host." + }, + "GetUsageAnalyzedLogs": { + "description": "Obtén el uso por hora de logs analizados (Monitorización de seguridad).\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de la API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de los logs analizados" + }, + "GetUsageAuditLogs": { + "description": "Obtén el uso por hora de logs de auditoría.\n**Nota:** Este endpoint ha quedado obsoleto.", + "summary": "Obtener el uso por hora de logs de auditoría" + }, + "GetUsageLambda": { + "description": "Obtén el uso por hora de Lambda.\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de las API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de Lambda" + }, + "GetUsageBillableSummary": { + "description": "Obtén el uso facturable de tu cuenta.\n\nEste endpoint sólo es accesible para [organizaciones de nivel superior](https://docs.datadoghq.com/account_management/multi_organization/).", + "summary": "Obtener el uso facturable de tu cuenta" + }, + "GetUsageCIApp": { + "description": "Obtén el uso por hora de CI Visibility.\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de la API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de CI Visibility" + }, + "GetUsageCloudSecurityPostureManagement": { + "description": "Obtén el uso por hora de la gestión de seguridad de la nube (CSM).\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de la API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de CSM Pro" + }, + "GetUsageCWS": { + "description": "Obtén el uso por hora de la seguridad de cargas de trabajo en la nube.\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de las API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de la seguridad de cargas de trabajo en la nube" + }, + "GetUsageDBM": { + "description": "Obtén el uso por hora de la monitorización de bases de datos.\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de las API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de la monitorización de bases de datos" + }, + "GetUsageFargate": { + "description": "Obtén el uso por hora de [Fargate](https://docs.datadoghq.com/integrations/ecs_fargate/)\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de las API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de Fargate" + }, + "GetUsageHosts": { + "description": "Obtén el uso por hora de hosts y contenedores.\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de las API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de hosts y contenedores" + }, + "GetHourlyUsageAttribution": { + "description": "Obtén la atribución de uso por hora. Los datos de múltiples regiones estarán disponibles a partir del 1 de marzo de 2023.\n\nEl endpoint de esta API está paginado. Para asegurarte de que recibes todos los registros, comprueba si el valor de `next_record_id` está\ndefinido en la respuesta. Si lo está, realiza otra solicitud y pasa `next_record_id` como parámetro.\nEjemplo de pseudocódigo:\n\n```\nresponse := GetHourlyUsageAttribution(start_month)\ncursor := response.metadata.pagination.next_record_id\nWHILE cursor != null BEGIN\nsleep(5 seconds) # Evita alcanzar el límite de frecuencia\nresponse := GetHourlyUsageAttribution(start_month, next_record_id=cursor)\ncursor := response.metadata.pagination.next_record_id\nEND", + "summary": "Obtener la atribución de uso por hora" + }, + "GetIncidentManagement": { + "description": "Obtén el uso por hora de la gestión de incidentes.\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de las API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de la gestión de incidentes" + }, + "GetUsageIndexedSpans": { + "description": "Obtén el uso por hora de tramos (spans) indexados.\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de las API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de tramos indexados" + }, + "GetIngestedSpans": { + "description": "Obtén el uso por hora de tramos ingeridos.\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de las API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de tramos ingeridos" + }, + "GetUsageInternetOfThings": { + "description": "Obtén el uso por hora de IoT.\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de las API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de IoT" + }, + "GetUsageLogs": { + "description": "Obtén el uso por hora de logs.\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de las API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de logs" + }, + "GetUsageLogsByRetention": { + "description": "Obtén el uso por hora de logs indexados por periodo de conservación.\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de las API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de logs por retención" + }, + "GetUsageLogsByIndex": { + "description": "Obtén el uso por hora de logs por índice.", + "summary": "Obtener el uso por hora de logs por índice" + }, + "GetMonthlyUsageAttribution": { + "description": "Obtén la atribución de uso por mes. Los datos de múltiples regiones estarán disponibles a partir del 1 de marzo de 2023.\n\nEl endpoint de esta API está paginado. Para asegurarte de que recibes todos los registros, comprueba si el valor de `next_record_id` está\ndefinido en la respuesta. Si lo está, realiza otra solicitud y pasa `next_record_id` como parámetro.\nEjemplo de pseudocódigo:\n\n```\nresponse := GetMonthlyUsageAttribution(start_month)\ncursor := response.metadata.pagination.next_record_id\nWHILE cursor != null BEGIN\nsleep(5 seconds) # Evita alcanzar el límite de la frecuencia\nresponse := GetMonthlyUsageAttribution(start_month, next_record_id=cursor)\ncursor := response.metadata.pagination.next_record_id\nEND\n```", + "summary": "Obtenga la atribución de uso por mes" + }, + "GetUsageNetworkFlows": { + "description": "Obtén el uso por hora de flujos de red.\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de las API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de flujos de red" + }, + "GetUsageNetworkHosts": { + "description": "Obtén el uso por hora de hosts de red.\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de las API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de hosts de red" + }, + "GetUsageOnlineArchive": { + "description": "Obtén el uso por hora de archivos en línea.\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de las API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de archivos en línea" + }, + "GetUsageProfiling": { + "description": "Obtén el uso por hora de hosts con perfiles.\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de las API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de hosts con perfiles" + }, + "GetUsageRumUnits": { + "description": "Obtén el uso por hora de unidades [RUM](https://docs.datadoghq.com/real_user_monitoring/).\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de las API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de unidades RUM" + }, + "GetUsageRumSessions": { + "description": "Obtén el uso por hora de sesiones [RUM](https://docs.datadoghq.com/real_user_monitoring/).\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de las API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de sesiones RUM" + }, + "GetUsageSDS": { + "description": "Obtén el uso por hora del Sensitive Data Scanner.\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de las API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora del Sensitive Data Scanner" + }, + "GetUsageSNMP": { + "description": "Obtén el uso por hora de dispositivos SNMP.\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de las API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de dispositivos SNMP" + }, + "GetUsageSummary": { + "description": "Obtén el uso de tu cuenta.\n\nEste endpoint solo es accesible para [organizaciones de nivel superior](https://docs.datadoghq.com/account_management/multi_organization/).", + "summary": "Obtener el uso de tu cuenta" + }, + "GetUsageSynthetics": { + "description": "Obtén el uso por hora de [checks de Synthetic](https://docs.datadoghq.com/synthetics/)\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de las API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de checks de Synthetic" + }, + "GetUsageSyntheticsAPI": { + "description": "Obtén el uso por hora de [checks de API Synthetic](https://docs.datadoghq.com/synthetics/)\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de las API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de checks de API Synthetic" + }, + "GetUsageSyntheticsBrowser": { + "description": "Obtén el uso por hora de checks de navegador Synthetic.\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de las API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de checks de navegador Synthetic" + }, + "GetUsageTimeseries": { + "description": "Obtén el uso por hora de [métricas personalizadas].\n**Nota:** Este endpoint ha quedado obsoleto. Los datos de uso por hora de todos los productos están ahora disponibles en [Obtener el uso por hora por API de familia de productos](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Consulta [Migración de las API de uso horario de la V1 a la V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) para obtener la guía de migración asociada.", + "summary": "Obtener el uso por hora de métricas personalizadas" + }, + "GetUsageTopAvgMetrics": { + "description": "Obtén todas las [métricas personalizadas](https://docs.datadoghq.com/developers/metrics/custom_metrics/) por media horaria. Utiliza el parámetro mes para obtener una resolución de los datos del mes hasta la fecha o utiliza el parámetro día para obtener una resolución diaria. Se requiere uno de los dos y sólo se permite uno de los dos.", + "summary": "Obtener todas las métricas personalizadas por media horaria" + }, + "ListUsers": { + "description": "Enumera todos los usuarios de tu organización.", + "summary": "Mostrar una lista con todos los usuarios" + }, + "CreateUser": { + "description": "Crea un usuario para tu organización.\n\n**Nota**: Los usuarios sólo pueden crearse con el rol de acceso de administrador,\nsi las claves de la aplicación pertenecen a los administradores.", + "summary": "Crear un usuario", + "request_description": "Objeto de usuario a crear.", + "request_schema_description": "Crea, edita y desactiva usuarios." + }, + "DisableUser": { + "description": "Elimina un usuario de una organización.\n\n**Nota**: Este endpoint sólo puede utilizarse con claves de aplicación pertenecientes a\nadministradores.", + "summary": "Desactivar un usuario" + }, + "GetUser": { + "description": "Obtén los datos de un usuario.", + "summary": "Recibir los detalles de un usuario" + }, + "UpdateUser": { + "description": "Actualiza la información de un usuario.\n\n**Nota**: Sólo puede utilizarse con claves de aplicación pertenecientes a administradores.", + "summary": "Modificar un usuario", + "request_description": "Descripción de la actualización.", + "request_schema_description": "Crea, edita y desactiva usuarios." + }, + "Validate": { + "description": "Comprueba si la clave de API (no la clave de aplicación) es válida. Si no es válida, se devuelve un 403.", + "summary": "Validar una clave de API" + }, + "SubmitLog": { + "description": "Envía tus logs a tu plataforma Datadog a través de HTTP. Los límites por solicitud HTTP son:\n\n- Tamaño máximo de contenido por carga útil (sin comprimir): 5MB\n- Tamaño máximo para un único log: 1MB\n- Tamaño máximo de la matriz, si se envían varios logs en una matriz: 1000 entradas\n\nCualquier log que supere 1MB es aceptado y truncado por Datadog:\n- Para una única solicitud de log, la API trunca el log a 1MB y devuelve un 2xx.\n- Para una solicitud de varios logs, la API procesa todos los logs, trunca sólo los logs mayores a 1MB, y devuelve un 2xx.\n\nDatadog recomienda enviar tus logs comprimidos.\nAñade la cabecera `Content-Encoding: gzip` a la solicitud cuando envíes logs comprimidos.\n\nLos códigos de estado que responde la API HTTP son:\n- 200: OK\n- 400: Solicitud incorrecta (probablemente un problema en el formato de la carga útil)\n- 403: Problema de permisos (probablemente se ha utilizado una clave de API no válida)\n- 413: Carga demasiado grande (el lote supera los 5 MB sin comprimir)\n- 5xx: Error interno, la solicitud debe ser reintentada después de algún tiempo", + "summary": "Enviar logs", + "request_description": "Registro que hay que enviar (en formato JSON).", + "request_schema_description": "Mensaje de registro estructurado." + }, + "MuteAllMonitors": { + "description": "El silenciado impide que todos los monitores envíen notificaciones a través de correo electrónico y mensajes al\n[flujo de eventos](https://docs.datadoghq.com/events).\nLos cambios de estado sólo son visibles si se controla la página de alertas.", + "summary": "Silenciar todos los monitores" + }, + "UnmuteAllMonitors": { + "description": "Desactiva el silenciamiento de todos los monitores. Crea un error si el silenciamiento general\nno estaba activado previamente.", + "summary": "Desactivar el silenciamiento de todos los monitores" + } +} \ No newline at end of file diff --git a/data/api/v1/translate_tags.es.json b/data/api/v1/translate_tags.es.json new file mode 100644 index 0000000000000..f61926ee7de0f --- /dev/null +++ b/data/api/v1/translate_tags.es.json @@ -0,0 +1,142 @@ +{ + "aws-integration": { + "name": "Integración de AWS", + "description": "Configura tu integración AWS en Datadog directamente a través de la API Datadog.\nPara obtener más información, consulta la [página de la integración AWS](https://docs.datadoghq.com/integrations/amazon_web_services)." + }, + "aws-logs-integration": { + "name": "Integración de logs de AWS", + "description": "Configura tu integración de logs de AWS en Datadog directamente a través de la API Datadog.\nPara obtener más información, consulta la [página de la integración AWS](https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection)." + }, + "authentication": { + "name": "Autenticación", + "description": "Todas las solicitudes a la API Datadog deben estar autenticadas.\nLas solicitudes de escritura de datos requieren acceso a informes y una \"clave de API\".\nLas solicitudes de lectura de datos requieren acceso total y también una \"clave de aplicación\".\n\n**Nota:** Todos los clientes de la API Datadog están configurados por defecto para consumir las API del sitio Datadog US.\nSi te encuentras en el sitio Datadog EU, configura la variable de entorno `DATADOG_HOST` como\n`https://api.datadoghq.eu` o anula este valor directamente al crear tu cliente.\n\n[Gestiona las claves de API y de aplicación de tu cuenta](https://app.datadoghq.com/organization-settings/) en Datadog y consulta la [página Claves de API y de aplicación](https://docs.datadoghq.com/account_management/api-app-keys/) en la documentación." + }, + "azure-integration": { + "name": "Integración Azure", + "description": "Configura tu integración Azure en Datadog directamente a través de la API Datadog.\nPara obtener más información, consulta la [página de la integración Azure en Datadog](https://docs.datadoghq.com/integrations/azure)." + }, + "dashboard-lists": { + "name": "Recibir los elementos de una lista de dashboards", + "description": "Interactúa con tus listas de dashboards a través de la API para\norganizar, buscar y compartir todos tus dashboards con tu equipo y\ntu organización." + }, + "dashboards": { + "name": "Dashboards", + "description": "Gestiona todos tus dashboards, así como el acceso a tus dashboards compartidos, a través de la API. Para obtener más información, consulta la [página Dashboards](https://docs.datadoghq.com/dashboards/)." + }, + "downtimes": { + "name": "Tiempos de inactividad", + "description": "El [tiempo de inactividad](https://docs.datadoghq.com/monitors/notify/downtimes) te proporciona\nun mayor control sobre las notificaciones de monitores, ya que te permite excluir globalmente\ncontextos de alerta. La configuración de tiempos de inactividad, que pueden programarse con horas de inicio y \nhoras de fin, evita todas las alertas relacionadas con etiquetas (tags) de Datadog." + }, + "embeddable-graphs": { + "name": "Gráficos integrables", + "description": "Gestiona gráficos integrables a través de la API. Para obtener más información, consulta [Gráficos integrables con variables de plantilla](https://docs.datadoghq.com/dashboards/guide/embeddable-graphs-with-template-variables/)." + }, + "events": { + "name": "Eventos", + "description": "La API de gestión de eventos permite publicar mediante programación eventos en el Explorador de eventos\ny recuperar eventos desde el Explorador de eventos. Para obtener más información, consulta la [página Gestión de eventos](https://docs.datadoghq.com/service_management/events/)." + }, + "gcp-integration": { + "name": "Integración GCP", + "description": "Configura tu integración Google Cloud Platform (GCP) en Datadog directamente\na través de la API Datadog. Consulta más información sobre la [integración Google Cloud Platform (GCP) en Datadog](https://docs.datadoghq.com/integrations/google_cloud_platform)." + }, + "hosts": { + "name": "Hosts", + "description": "Obtén información sobre los hosts de tu infraestructura en Datadog y silencia o desactiva el silencio de cualquier notificación de tus hosts. Para obtener más información, consulta la [página Infraestructura](https://docs.datadoghq.com/infrastructure/)." + }, + "ip-ranges": { + "name": "Edita una clave de aplicación que pertenece al usuario actual.", + "description": "Obtén una lista de prefijos de IP pertenecientes a Datadog." + }, + "key-management": { + "name": "Elimina una clave de aplicación que pertenece al usuario actual.", + "description": "Gestiona tus claves de API y de aplicación de Datadog. Se necesita una clave de API y\nuna clave de aplicación para que un usuario con los permisos necesarios interactúe\ncon estos endpoints. Puedes consultar la lista completa de claves de API y de aplicación\nen la [página de tu API Datadog](https://app.datadoghq.com/account/settings#api)." + }, + "logs": { + "name": "Logs", + "description": "Busca tus logs y envíalos a tu plataforma Datadog a través de HTTP. Para obtener más información, consulta la [página Gestión de logs](https://docs.datadoghq.com/logs/)." + }, + "logs-indexes": { + "name": "Índices de logs", + "description": "Gestiona la configuración de [índices de logs](https://docs.datadoghq.com/logs/indexes/).\nPara interactuar con este endpoint, necesitas una clave de API y de aplicación con derechos de administrador." + }, + "logs-pipelines": { + "name": "Pipelines de logs", + "description": "Los pipelines y procesadores operan sobre los logs entrantes, analizándolos\ny transformándolos en atributos estructurados para facilitar su consulta.\n\n- Consulta la [página de configuración de pipelines](https://app.datadoghq.com/logs/pipelines)\npara obtener una lista de los pipelines y los procesadores actualmente configurados en la interfaz de usuario web.\n\n- Puedes encontrar información adicional sobre procesadores, relacionada con la API, en la\n[documentación de los procesadores](https://docs.datadoghq.com/logs/log_configuration/processors/?tab=api#lookup-processor).\n\n- Para obtener más información sobre pipelines, consulta la\n[documentación de los pipelines](https://docs.datadoghq.com/logs/log_configuration/pipelines).\n\n**Notas:**\n\nEstos endpoints sólo están disponibles para usuarios administradores.\nAsegúrate de utilizar una clave de aplicación creada por un administrador.\n\n**Las reglas de análisis Grok pueden afectar al resultado JSON y requieren\nque los datos devueltos se configuren antes de ser utilizados en una solicitud.**\nPor ejemplo, si utilizas los datos devueltos por una\nsolicitud para otro cuerpo de solicitud y tienes una regla de análisis\nque utiliza un patrón de expresiones regulares como `\\s` para los espacios,\ntendrás que configurar todos los espacios escapados como `%{space}` para utilizarlos\nen los datos del cuerpo.\n" + }, + "metrics": { + "name": "Métricas", + "description": "El endpoint de métricas te permite:\n\n- Publicar datos de métricas para que se puedan representar gráficamente en dashboards de Datadog\n- Consultar métricas de cualquier periodo de tiempo\n- Modificar las configuraciones de etiquetas de métricas\n- Ver etiquetas y volúmenes de métricas\n\n**Nota**: Un gráfico sólo puede contener un número determinado de puntos\ny a medida que aumenta el marco temporal en el que se visualiza una métrica,\nla agregación entre puntos se mantiene por debajo de ese número establecido.\n\nLos métodos Post, Patch y Delete de la API `manage_tags` sólo pueden ser ejecutados por\nun usuario que tenga el permiso `Gestionar etiquetas de métricas`.\n\nPara obtener más información, consulta la [página Métricas](https://docs.datadoghq.com/metrics/)." + }, + "monitors": { + "name": "Monitores", + "description": "Los [monitores](https://docs.datadoghq.com/monitors) te permiten observar una métrica o un check que te interese y\nnotificar a tu equipo cuando se supera un umbral definido.\n\nPara obtener más información, consulta la [creación de monitores](https://docs.datadoghq.com/monitors/create/types/)." + }, + "notebooks": { + "name": "Notebooks", + "description": "Interactúa con tus notebooks a través de la API para que sea más fácil organizar, buscar y\ncompartir todos tus notebooks con tu equipo y tu organización. Para obtener más información, consulta la\n[documentación de los notebooks](https://docs.datadoghq.com/notebooks/)." + }, + "organizations": { + "name": "Organizaciones", + "description": "Crea, edita y gestiona tus organizaciones. Consulta más información sobre [cuentas multi-organización](https://docs.datadoghq.com/account_management/multi_organization)." + }, + "pagerduty-integration": { + "name": "Eliminar un único objeto de servicio", + "description": "Configura tu [integración PagerDuty en Datadog](https://docs.datadoghq.com/integrations/pagerduty/)\ndirectamente a través de la API Datadog." + }, + "screenboards": { + "name": "Screenboards", + "description": "Este endpoint está obsoleto. Utiliza el [nuevo endpoint del dashboard](https://docs.datadoghq.com/api/#dashboards)." + }, + "security-monitoring": { + "name": "Ver una lista de señales de seguridad", + "description": "Crea y gestiona tus reglas de seguridad, señales, filtros y mucho más. Para obtener más información, consulta la [página Seguridad de Datadog](https://docs.datadoghq.com/security/)." + }, + "service-checks": { + "name": "Checks de los servicios", + "description": "El endpoint del check de servicio permite publicar estados de checks para su uso con monitores.\nLos mensajes de checks de servicio están limitados a 500 caracteres. Si se publica un check con un mensaje\nque contiene más de 500 caracteres, sólo se muestran los primeros 500 caracteres. Los mensajes\nestán limitados para checks con estado Crítico o Advertencia, se eliminan para checks con\nestado Ok.\n\n- Más información sobre monitores de checks de servicio][1].\n- Más información sobre monitores de checks de proceso][2].\n- Más información sobre monitores de red][3].\n- Más información sobre monitores de checks personalizados][4].\n- Más información sobre checks de servicio y códigos de estado][5].\n\n[1]: https://docs.datadoghq.com/monitors/types/service_check/\n[2]: https://docs.datadoghq.com/monitors/create/types/process_check/?tab=checkalert\n[3]: https://docs.datadoghq.com/monitors/create/types/network/?tab=checkalert\n[4]: https://docs.datadoghq.com/monitors/create/types/custom_check/?tab=checkalert\n[5]: https://docs.datadoghq.com/developers/service_checks/" + }, + "service-dependencies": { + "name": "Dependencias de servicios", + "description": "API de mapa de servicios APM. Para obtener más información, visita\nla [página Mapa de servicios](https://docs.datadoghq.com/tracing/visualization/services_map/)." + }, + "service-level-objective-corrections": { + "name": "Correcciones de objetivos de nivel de servicio (SLOs)", + "description": "Las correcciones del estado de SLOs te permiten evitar que periodos de tiempo específicos tengan un impacto negativo en el estado y el total de errores de tu SLO. Puedes utilizar las correcciones de estados para varios fines, como\neliminar ventanas de mantenimiento planificado, horas no laborables u otros períodos de tiempo que\nno correspondan a problemas reales. Para obtener más información, consulta [Correcciones de estados de SLOs](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-status-corrections)." + }, + "service-level-objectives": { + "name": "Objetivos de nivel de servicio (SLOs)", + "description": "[Objetivos de nivel de servicio (SLOs)](https://docs.datadoghq.com/monitors/service_level_objectives/#configuration)\nLos (SLOs) son una parte fundamental del conjunto de herramientas de ingeniería de fiabilidad del sitio.\nLos SLOs proporcionan un marco para definir objetivos claros en torno al rendimiento de las aplicaciones,\nlo que, en última instancia, ayuda a los equipos a ofrecer una experiencia coherente al cliente,\na equilibrar el desarrollo de funciones con la estabilidad de la plataforma\ny a mejorar la comunicación con los usuarios internos y externos." + }, + "slack-integration": { + "name": "Integración Slack", + "description": "Configura tu [integración Slack en Datadog](https://docs.datadoghq.com/integrations/slack) directamente a través de la API Datadog." + }, + "snapshots": { + "name": "Snapshots", + "description": "Toma snapshots de gráficos utilizando la API." + }, + "synthetics": { + "name": "Synthetics", + "description": "La monitorización Synthetic Datadog utiliza solicitudes de usuario simuladas y la renderización del navegador para ayudarte a garantizar el tiempo de actividad,\nidentificar problemas regionales y realizar un seguimiento del rendimiento de tu aplicación. Los tests Synthetics vienen\nen dos formatos diferentes, [tests de API]((https://docs.datadoghq.com/synthetics/api_tests/?tab=httptest)\ny [tests de navegador](https://docs.datadoghq.com/synthetics/browser_tests). Puedes utilizar la API Datadog para\ngestionar ambos tipos de tests mediante programación.\n\nPara obtener más información, consulta la [documentación de la monitorización Synthetic](https://docs.datadoghq.com/synthetics/)." + }, + "tags": { + "name": "Etiquetas", + "description": "El endpoint de etiquetas permite asignar etiquetas a hosts,\npor ejemplo: `role:database`. Esas etiquetas se aplican a\ntodas las métricas enviadas por el host. Consulta hosts por su nombre\n(`yourhost.example.com`) cuando busques y apliques\netiquetas a un host concreto.\n\nEl componente de tu infraestructura responsable de una etiqueta se identifica\npor una fuente. Por ejemplo, algunas fuentes válidas incluyen nagios, hudson, jenkins,\nusers, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc.\n\nMás información sobre etiquetas en [Empezando con etiquetas](https://docs.datadoghq.com/getting_started/tagging/)." + }, + "timeboards": { + "name": "Timeboards", + "description": "Este endpoint está obsoleto. Utiliza el [nuevo endpoint del dashboard](https://docs.datadoghq.com/api/#dashboards)." + }, + "usage-metering": { + "name": "Medición del uso", + "description": "La API de medición del uso te permite obtener el uso horario, diario y\nmensual a través de múltiples facetas de Datadog.\nEsta API está disponible para todos los clientes Pro y Enterprise.\n\n**Nota**: Los datos de uso se retrasan hasta 72 horas desde el momento en que se produjeron.\nSe conservan durante 15 meses.\n\nPuedes recuperar hasta 24 horas de datos de uso por hora de varias organizaciones\ny hasta 2 meses de datos de uso por hora de una sola organización en una sola solicitud.\nConsulta más información en la [documentación de detalles de uso](https://docs.datadoghq.com/account_management/billing/usage_details/)." + }, + "users": { + "name": "Usuarios", + "description": "Crea, edita y desactiva usuarios." + }, + "webhooks-integration": { + "name": "Integración de webhooks", + "description": "Configura tu integración de webhooks en Datadog directamente a través de la API Datadog. Para obtener más información, consulta la [página de la integración de webhooks](https://docs.datadoghq.com/integrations/webhooks)." + } +} \ No newline at end of file diff --git a/layouts/shortcodes/observability_pipelines/install_worker/kubernetes.md b/layouts/shortcodes/observability_pipelines/install_worker/kubernetes.md index 5ab8da3b02cc7..f6986f1a7452b 100644 --- a/layouts/shortcodes/observability_pipelines/install_worker/kubernetes.md +++ b/layouts/shortcodes/observability_pipelines/install_worker/kubernetes.md @@ -1,4 +1,4 @@ -1. Download the [Helm chart values file][601]. +1. Download the [Helm chart values file][601]. If you are not using a managed service such as Amazon EKS, Google GKE, or Azure AKS, see [Self-hosted and self-managed Kubernetes clusters](#self-hosted-and-self-managed-kubernetes-clusters) before continuing to the next step. 1. Click **Select API key** to choose the Datadog API key you want to use. 1. Add the Datadog chart repository to Helm: ```shell @@ -23,9 +23,13 @@ ``` --set service.ports[0].protocol=TCP,service.ports[0].port=8088,service.ports[0].targetPort=8282 ``` -1. Navigate back to the Observability Pipelines installation page and click **Deploy**. +1. Navigate back to the Observability Pipelines installation page and click **Deploy**.

See [Update Existing Pipelines][602] if you want to make changes to your pipeline's configuration. +#### Self-hosted and self-managed Kubernetes clusters + +If you are running a self-hosted and self-managed Kubernetes cluster, and have defined zones with node labels using `topology.kubernetes.io/zone`, then you can use the Helm chart values file as is. However, if you are not using the label `topology.kubernetes.io/zone`, you need to update the `topologyKey` in the `values.yaml` file to match the key you are using. Or if you run your Kubernetes install without zones, remove the entire `topology.kubernetes.io/zone` section. + [601]: /resources/yaml/observability_pipelines/v2/setup/values.yaml [602]: /observability_pipelines/update_existing_pipelines \ No newline at end of file diff --git a/static/resources/json/full_spec_v1.json b/static/resources/json/full_spec_v1.json index 0390d7343d970..2979de233607d 100644 --- a/static/resources/json/full_spec_v1.json +++ b/static/resources/json/full_spec_v1.json @@ -490314,6 +490314,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -490414,11 +490417,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -490532,6 +490560,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -490542,6 +490575,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -501145,6 +501182,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -501245,11 +501285,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -501363,6 +501428,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -501373,6 +501443,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -510368,6 +510442,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -510468,11 +510545,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -510586,6 +510688,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -510596,6 +510703,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -510856,6 +510967,7 @@ }, "name": { "description": "The name of the step.", + "example": "", "maxLength": 1500, "type": "string" }, @@ -510864,7 +510976,235 @@ "type": "boolean" }, "params": { - "description": "The parameters of the mobile step.", + "description": "The parameters of a mobile step.", + "properties": { + "check": { + "description": "Type of assertion to apply in an API test.", + "enum": [ + "equals", + "notEquals", + "contains", + "notContains", + "startsWith", + "notStartsWith", + "greater", + "lower", + "greaterEquals", + "lowerEquals", + "matchRegex", + "between", + "isEmpty", + "notIsEmpty" + ], + "type": "string", + "x-enum-varnames": [ + "EQUALS", + "NOT_EQUALS", + "CONTAINS", + "NOT_CONTAINS", + "STARTS_WITH", + "NOT_STARTS_WITH", + "GREATER", + "LOWER", + "GREATER_EQUALS", + "LOWER_EQUALS", + "MATCH_REGEX", + "BETWEEN", + "IS_EMPTY", + "NOT_IS_EMPTY" + ] + }, + "delay": { + "description": "Number of milliseconds to wait between inputs in a `typeText` step type.", + "format": "int64", + "maximum": 5000, + "minimum": 0, + "type": "integer" + }, + "direction": { + "description": "The direction of the scroll for a `scrollToElement` step type.", + "enum": [ + "up", + "down", + "left", + "right" + ], + "type": "string", + "x-enum-varnames": [ + "UP", + "DOWN", + "LEFT", + "RIGHT" + ] + }, + "element": { + "description": "Information about the element used for a step.", + "properties": { + "context": { + "description": "Context of the element.", + "type": "string" + }, + "contextType": { + "description": "Type of the context that the element is in.", + "enum": [ + "native", + "web" + ], + "type": "string", + "x-enum-varnames": [ + "NATIVE", + "WEB" + ] + }, + "elementDescription": { + "description": "Description of the element.", + "type": "string" + }, + "multiLocator": { + "description": "Multi-locator to find the element.", + "type": "object" + }, + "relativePosition": { + "description": "Position of the action relative to the element.", + "properties": { + "x": { + "description": "The `relativePosition` on the `x` axis for the element.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `relativePosition` on the `y` axis for the element.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "textContent": { + "description": "Text content of the element.", + "type": "string" + }, + "userLocator": { + "description": "User locator to find the element.", + "properties": { + "failTestOnCannotLocate": { + "description": "Whether if the the test should fail if the element cannot be found.", + "type": "boolean" + }, + "values": { + "description": "Values of the user locator.", + "items": { + "description": "A single user locator object.", + "properties": { + "type": { + "description": "Type of a user locator.", + "enum": [ + "accessibility-id", + "id", + "ios-predicate-string", + "ios-class-chain", + "xpath" + ], + "type": "string", + "x-enum-varnames": [ + "ACCESSIBILITY_ID", + "ID", + "IOS_PREDICATE_STRING", + "IOS_CLASS_CHAIN", + "XPATH" + ] + }, + "value": { + "description": "Value of a user locator.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "viewName": { + "description": "Name of the view of the element.", + "type": "string" + } + }, + "type": "object" + }, + "enable": { + "description": "Boolean to change the state of the wifi for a `toggleWiFi` step type.", + "type": "boolean" + }, + "maxScrolls": { + "description": "Maximum number of scrolls to do for a `scrollToElement` step type.", + "format": "int64", + "type": "integer" + }, + "positions": { + "description": "List of positions for the `flick` step type. The maximum is 10 flicks per step", + "items": { + "description": "A description of a single position for a `flick` step type.", + "properties": { + "x": { + "description": "The `x` position for the flick.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `y` position for the flick.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "subtestPublicId": { + "description": "Public ID of the test to be played as part of a `playSubTest` step type.", + "type": "string" + }, + "value": { + "description": "Values used in the step. Used in multiple step types.", + "type": "string" + }, + "variable": { + "description": "Variable object for `extractVariable` step type.", + "properties": { + "example": { + "description": "An example for the variable.", + "example": "", + "type": "string" + }, + "name": { + "description": "The variable name.", + "example": "VAR_NAME", + "type": "string" + } + }, + "required": [ + "name", + "example" + ], + "type": "object" + }, + "withEnter": { + "description": "Boolean to indicate if `Enter` should be pressed at the end of the `typeText` step type.", + "type": "boolean" + }, + "x": { + "description": "Amount to scroll by on the `x` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "Amount to scroll by on the `y` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + } + }, "type": "object" }, "publicId": { @@ -510921,6 +511261,527 @@ ] } }, + "required": [ + "name", + "params", + "type" + ], + "type": "object" + }, + "SyntheticsMobileStepParams": { + "description": "The parameters of a mobile step.", + "properties": { + "check": { + "description": "Type of assertion to apply in an API test.", + "enum": [ + "equals", + "notEquals", + "contains", + "notContains", + "startsWith", + "notStartsWith", + "greater", + "lower", + "greaterEquals", + "lowerEquals", + "matchRegex", + "between", + "isEmpty", + "notIsEmpty" + ], + "type": "string", + "x-enum-varnames": [ + "EQUALS", + "NOT_EQUALS", + "CONTAINS", + "NOT_CONTAINS", + "STARTS_WITH", + "NOT_STARTS_WITH", + "GREATER", + "LOWER", + "GREATER_EQUALS", + "LOWER_EQUALS", + "MATCH_REGEX", + "BETWEEN", + "IS_EMPTY", + "NOT_IS_EMPTY" + ] + }, + "delay": { + "description": "Number of milliseconds to wait between inputs in a `typeText` step type.", + "format": "int64", + "maximum": 5000, + "minimum": 0, + "type": "integer" + }, + "direction": { + "description": "The direction of the scroll for a `scrollToElement` step type.", + "enum": [ + "up", + "down", + "left", + "right" + ], + "type": "string", + "x-enum-varnames": [ + "UP", + "DOWN", + "LEFT", + "RIGHT" + ] + }, + "element": { + "description": "Information about the element used for a step.", + "properties": { + "context": { + "description": "Context of the element.", + "type": "string" + }, + "contextType": { + "description": "Type of the context that the element is in.", + "enum": [ + "native", + "web" + ], + "type": "string", + "x-enum-varnames": [ + "NATIVE", + "WEB" + ] + }, + "elementDescription": { + "description": "Description of the element.", + "type": "string" + }, + "multiLocator": { + "description": "Multi-locator to find the element.", + "type": "object" + }, + "relativePosition": { + "description": "Position of the action relative to the element.", + "properties": { + "x": { + "description": "The `relativePosition` on the `x` axis for the element.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `relativePosition` on the `y` axis for the element.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "textContent": { + "description": "Text content of the element.", + "type": "string" + }, + "userLocator": { + "description": "User locator to find the element.", + "properties": { + "failTestOnCannotLocate": { + "description": "Whether if the the test should fail if the element cannot be found.", + "type": "boolean" + }, + "values": { + "description": "Values of the user locator.", + "items": { + "description": "A single user locator object.", + "properties": { + "type": { + "description": "Type of a user locator.", + "enum": [ + "accessibility-id", + "id", + "ios-predicate-string", + "ios-class-chain", + "xpath" + ], + "type": "string", + "x-enum-varnames": [ + "ACCESSIBILITY_ID", + "ID", + "IOS_PREDICATE_STRING", + "IOS_CLASS_CHAIN", + "XPATH" + ] + }, + "value": { + "description": "Value of a user locator.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "viewName": { + "description": "Name of the view of the element.", + "type": "string" + } + }, + "type": "object" + }, + "enable": { + "description": "Boolean to change the state of the wifi for a `toggleWiFi` step type.", + "type": "boolean" + }, + "maxScrolls": { + "description": "Maximum number of scrolls to do for a `scrollToElement` step type.", + "format": "int64", + "type": "integer" + }, + "positions": { + "description": "List of positions for the `flick` step type. The maximum is 10 flicks per step", + "items": { + "description": "A description of a single position for a `flick` step type.", + "properties": { + "x": { + "description": "The `x` position for the flick.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `y` position for the flick.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "subtestPublicId": { + "description": "Public ID of the test to be played as part of a `playSubTest` step type.", + "type": "string" + }, + "value": { + "description": "Values used in the step. Used in multiple step types.", + "type": "string" + }, + "variable": { + "description": "Variable object for `extractVariable` step type.", + "properties": { + "example": { + "description": "An example for the variable.", + "example": "", + "type": "string" + }, + "name": { + "description": "The variable name.", + "example": "VAR_NAME", + "type": "string" + } + }, + "required": [ + "name", + "example" + ], + "type": "object" + }, + "withEnter": { + "description": "Boolean to indicate if `Enter` should be pressed at the end of the `typeText` step type.", + "type": "boolean" + }, + "x": { + "description": "Amount to scroll by on the `x` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "Amount to scroll by on the `y` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "SyntheticsMobileStepParamsDirection": { + "description": "The direction of the scroll for a `scrollToElement` step type.", + "enum": [ + "up", + "down", + "left", + "right" + ], + "type": "string", + "x-enum-varnames": [ + "UP", + "DOWN", + "LEFT", + "RIGHT" + ] + }, + "SyntheticsMobileStepParamsElement": { + "description": "Information about the element used for a step.", + "properties": { + "context": { + "description": "Context of the element.", + "type": "string" + }, + "contextType": { + "description": "Type of the context that the element is in.", + "enum": [ + "native", + "web" + ], + "type": "string", + "x-enum-varnames": [ + "NATIVE", + "WEB" + ] + }, + "elementDescription": { + "description": "Description of the element.", + "type": "string" + }, + "multiLocator": { + "description": "Multi-locator to find the element.", + "type": "object" + }, + "relativePosition": { + "description": "Position of the action relative to the element.", + "properties": { + "x": { + "description": "The `relativePosition` on the `x` axis for the element.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `relativePosition` on the `y` axis for the element.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "textContent": { + "description": "Text content of the element.", + "type": "string" + }, + "userLocator": { + "description": "User locator to find the element.", + "properties": { + "failTestOnCannotLocate": { + "description": "Whether if the the test should fail if the element cannot be found.", + "type": "boolean" + }, + "values": { + "description": "Values of the user locator.", + "items": { + "description": "A single user locator object.", + "properties": { + "type": { + "description": "Type of a user locator.", + "enum": [ + "accessibility-id", + "id", + "ios-predicate-string", + "ios-class-chain", + "xpath" + ], + "type": "string", + "x-enum-varnames": [ + "ACCESSIBILITY_ID", + "ID", + "IOS_PREDICATE_STRING", + "IOS_CLASS_CHAIN", + "XPATH" + ] + }, + "value": { + "description": "Value of a user locator.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "viewName": { + "description": "Name of the view of the element.", + "type": "string" + } + }, + "type": "object" + }, + "SyntheticsMobileStepParamsElementContextType": { + "description": "Type of the context that the element is in.", + "enum": [ + "native", + "web" + ], + "type": "string", + "x-enum-varnames": [ + "NATIVE", + "WEB" + ] + }, + "SyntheticsMobileStepParamsElementRelativePosition": { + "description": "Position of the action relative to the element.", + "properties": { + "x": { + "description": "The `relativePosition` on the `x` axis for the element.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `relativePosition` on the `y` axis for the element.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "SyntheticsMobileStepParamsElementUserLocator": { + "description": "User locator to find the element.", + "properties": { + "failTestOnCannotLocate": { + "description": "Whether if the the test should fail if the element cannot be found.", + "type": "boolean" + }, + "values": { + "description": "Values of the user locator.", + "items": { + "description": "A single user locator object.", + "properties": { + "type": { + "description": "Type of a user locator.", + "enum": [ + "accessibility-id", + "id", + "ios-predicate-string", + "ios-class-chain", + "xpath" + ], + "type": "string", + "x-enum-varnames": [ + "ACCESSIBILITY_ID", + "ID", + "IOS_PREDICATE_STRING", + "IOS_CLASS_CHAIN", + "XPATH" + ] + }, + "value": { + "description": "Value of a user locator.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "SyntheticsMobileStepParamsElementUserLocatorValuesItems": { + "description": "A single user locator object.", + "properties": { + "type": { + "description": "Type of a user locator.", + "enum": [ + "accessibility-id", + "id", + "ios-predicate-string", + "ios-class-chain", + "xpath" + ], + "type": "string", + "x-enum-varnames": [ + "ACCESSIBILITY_ID", + "ID", + "IOS_PREDICATE_STRING", + "IOS_CLASS_CHAIN", + "XPATH" + ] + }, + "value": { + "description": "Value of a user locator.", + "type": "string" + } + }, + "type": "object" + }, + "SyntheticsMobileStepParamsElementUserLocatorValuesItemsType": { + "description": "Type of a user locator.", + "enum": [ + "accessibility-id", + "id", + "ios-predicate-string", + "ios-class-chain", + "xpath" + ], + "type": "string", + "x-enum-varnames": [ + "ACCESSIBILITY_ID", + "ID", + "IOS_PREDICATE_STRING", + "IOS_CLASS_CHAIN", + "XPATH" + ] + }, + "SyntheticsMobileStepParamsPositions": { + "description": "List of positions for the `flick` step type. The maximum is 10 flicks per step", + "items": { + "description": "A description of a single position for a `flick` step type.", + "properties": { + "x": { + "description": "The `x` position for the flick.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `y` position for the flick.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "SyntheticsMobileStepParamsPositionsItems": { + "description": "A description of a single position for a `flick` step type.", + "properties": { + "x": { + "description": "The `x` position for the flick.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `y` position for the flick.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "SyntheticsMobileStepParamsVariable": { + "description": "Variable object for `extractVariable` step type.", + "properties": { + "example": { + "description": "An example for the variable.", + "example": "", + "type": "string" + }, + "name": { + "description": "The variable name.", + "example": "VAR_NAME", + "type": "string" + } + }, + "required": [ + "name", + "example" + ], "type": "object" }, "SyntheticsMobileStepType": { @@ -510973,20 +511834,11 @@ "description": "Configuration object for a Synthetic mobile test.", "properties": { "initialApplicationArguments": { - "description": "Initial application arguments for a mobile test.", - "properties": { - "propertyNames": { - "description": "Name of the property.", - "properties": { - "pattern": { - "description": "The `propertyNames` `pattern`.", - "example": "^(?!_dd).*$", - "type": "string" - } - }, - "type": "object" - } + "additionalProperties": { + "description": "A single application argument.", + "type": "string" }, + "description": "Initial application arguments for a mobile test.", "type": "object" }, "variables": { @@ -511044,7 +511896,7 @@ "type": "object" }, "device_ids": { - "description": "The `SyntheticsMobileTest` `device_ids`.", + "description": "Array with the different device IDs used to run the test.", "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -511073,7 +511925,7 @@ "description": "Object describing the extra options for a Synthetic test.", "properties": { "allowApplicationCrash": { - "description": "The `SyntheticsMobileTestOptions` `allowApplicationCrash`.", + "description": "A boolean to set if an application crash would mark the test as failed.", "type": "boolean" }, "bindings": { @@ -511081,32 +511933,26 @@ "items": { "description": "Objects describing the binding used for a mobile test.", "properties": { - "items": { - "description": "Object describing the binding used for a mobile test.", - "properties": { - "principals": { - "description": "List of principals for a mobile test binding.", - "items": { - "description": "A principal for a mobile test binding.", - "maxLength": 1500, - "type": "string" - }, - "type": "array" - }, - "role": { - "description": "The definition of `SyntheticsMobileTestBindingItemsRole` object.", - "enum": [ - "editor", - "viewer" - ], - "type": "string", - "x-enum-varnames": [ - "EDITOR", - "VIEWER" - ] - } + "principals": { + "description": "List of principals for a mobile test binding.", + "items": { + "description": "A principal for a mobile test binding.", + "maxLength": 1500, + "type": "string" }, - "type": "object" + "type": "array" + }, + "relation": { + "description": "The type of relation for the binding.", + "enum": [ + "editor", + "viewer" + ], + "type": "string", + "x-enum-varnames": [ + "EDITOR", + "VIEWER" + ] } }, "type": "object" @@ -511138,7 +511984,7 @@ "type": "object" }, "defaultStepTimeout": { - "description": "The `SyntheticsMobileTestOptions` `defaultStepTimeout`.", + "description": "The default timeout for steps in the test (in seconds).", "format": "int32", "maximum": 300, "minimum": 1, @@ -511146,6 +511992,9 @@ }, "device_ids": { "description": "For mobile test, array with the different device IDs used to run the test.", + "example": [ + "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16" + ], "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -511154,7 +512003,7 @@ "type": "array" }, "disableAutoAcceptAlert": { - "description": "The `SyntheticsMobileTestOptions` `disableAutoAcceptAlert`.", + "description": "A boolean to disable auto accepting alerts.", "type": "boolean" }, "min_failure_duration": { @@ -511169,11 +512018,13 @@ "properties": { "applicationId": { "description": "Application ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaaa", "maxLength": 1500, "type": "string" }, "referenceId": { "description": "Reference ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaab", "maxLength": 1500, "type": "string" }, @@ -511183,6 +512034,7 @@ "latest", "version" ], + "example": "latest", "type": "string", "x-enum-varnames": [ "LATEST", @@ -511190,6 +512042,11 @@ ] } }, + "required": [ + "applicationId", + "referenceId", + "referenceType" + ], "type": "object" }, "monitor_name": { @@ -511197,14 +512054,14 @@ "type": "string" }, "monitor_options": { - "description": "Object containing the options for a mobile Synthetic test as a monitor\n(for example, renotification).", + "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { "escalation_message": { "description": "Message to include in the escalation notification.", "type": "string" }, "notification_preset_name": { - "description": "The definition of `SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName` object.", + "description": "The name of the preset for the notification for the monitor.", "enum": [ "show_all", "hide_all", @@ -511226,7 +512083,7 @@ "type": "integer" }, "renotify_occurrences": { - "description": "The `SyntheticsMobileTestOptionsMonitorOptions` `renotify_occurrences`.", + "description": "The number of times to renotify if the test is still failing.", "format": "int64", "type": "integer" } @@ -511241,7 +512098,7 @@ "type": "integer" }, "noScreenshot": { - "description": "The `SyntheticsMobileTestOptions` `noScreenshot`.", + "description": "A boolean set to not take a screenshot for the step.", "type": "boolean" }, "restricted_roles": { @@ -511311,6 +512168,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -511321,23 +512183,33 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { "description": "The frequency at which to run the Synthetic test (in seconds).", + "example": 300, "format": "int64", "maximum": 604800, "minimum": 300, "type": "integer" }, "verbosity": { - "description": "The `SyntheticsMobileTestOptions` `verbosity`.", + "description": "The level of verbosity for the mobile test.", "format": "int32", "maximum": 5, "minimum": 0, "type": "integer" } }, + "required": [ + "device_ids", + "tick_every", + "mobileApplication" + ], "type": "object" }, "public_id": { @@ -511378,6 +512250,7 @@ }, "name": { "description": "The name of the step.", + "example": "", "maxLength": 1500, "type": "string" }, @@ -511386,7 +512259,235 @@ "type": "boolean" }, "params": { - "description": "The parameters of the mobile step.", + "description": "The parameters of a mobile step.", + "properties": { + "check": { + "description": "Type of assertion to apply in an API test.", + "enum": [ + "equals", + "notEquals", + "contains", + "notContains", + "startsWith", + "notStartsWith", + "greater", + "lower", + "greaterEquals", + "lowerEquals", + "matchRegex", + "between", + "isEmpty", + "notIsEmpty" + ], + "type": "string", + "x-enum-varnames": [ + "EQUALS", + "NOT_EQUALS", + "CONTAINS", + "NOT_CONTAINS", + "STARTS_WITH", + "NOT_STARTS_WITH", + "GREATER", + "LOWER", + "GREATER_EQUALS", + "LOWER_EQUALS", + "MATCH_REGEX", + "BETWEEN", + "IS_EMPTY", + "NOT_IS_EMPTY" + ] + }, + "delay": { + "description": "Number of milliseconds to wait between inputs in a `typeText` step type.", + "format": "int64", + "maximum": 5000, + "minimum": 0, + "type": "integer" + }, + "direction": { + "description": "The direction of the scroll for a `scrollToElement` step type.", + "enum": [ + "up", + "down", + "left", + "right" + ], + "type": "string", + "x-enum-varnames": [ + "UP", + "DOWN", + "LEFT", + "RIGHT" + ] + }, + "element": { + "description": "Information about the element used for a step.", + "properties": { + "context": { + "description": "Context of the element.", + "type": "string" + }, + "contextType": { + "description": "Type of the context that the element is in.", + "enum": [ + "native", + "web" + ], + "type": "string", + "x-enum-varnames": [ + "NATIVE", + "WEB" + ] + }, + "elementDescription": { + "description": "Description of the element.", + "type": "string" + }, + "multiLocator": { + "description": "Multi-locator to find the element.", + "type": "object" + }, + "relativePosition": { + "description": "Position of the action relative to the element.", + "properties": { + "x": { + "description": "The `relativePosition` on the `x` axis for the element.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `relativePosition` on the `y` axis for the element.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "textContent": { + "description": "Text content of the element.", + "type": "string" + }, + "userLocator": { + "description": "User locator to find the element.", + "properties": { + "failTestOnCannotLocate": { + "description": "Whether if the the test should fail if the element cannot be found.", + "type": "boolean" + }, + "values": { + "description": "Values of the user locator.", + "items": { + "description": "A single user locator object.", + "properties": { + "type": { + "description": "Type of a user locator.", + "enum": [ + "accessibility-id", + "id", + "ios-predicate-string", + "ios-class-chain", + "xpath" + ], + "type": "string", + "x-enum-varnames": [ + "ACCESSIBILITY_ID", + "ID", + "IOS_PREDICATE_STRING", + "IOS_CLASS_CHAIN", + "XPATH" + ] + }, + "value": { + "description": "Value of a user locator.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "viewName": { + "description": "Name of the view of the element.", + "type": "string" + } + }, + "type": "object" + }, + "enable": { + "description": "Boolean to change the state of the wifi for a `toggleWiFi` step type.", + "type": "boolean" + }, + "maxScrolls": { + "description": "Maximum number of scrolls to do for a `scrollToElement` step type.", + "format": "int64", + "type": "integer" + }, + "positions": { + "description": "List of positions for the `flick` step type. The maximum is 10 flicks per step", + "items": { + "description": "A description of a single position for a `flick` step type.", + "properties": { + "x": { + "description": "The `x` position for the flick.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `y` position for the flick.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "subtestPublicId": { + "description": "Public ID of the test to be played as part of a `playSubTest` step type.", + "type": "string" + }, + "value": { + "description": "Values used in the step. Used in multiple step types.", + "type": "string" + }, + "variable": { + "description": "Variable object for `extractVariable` step type.", + "properties": { + "example": { + "description": "An example for the variable.", + "example": "", + "type": "string" + }, + "name": { + "description": "The variable name.", + "example": "VAR_NAME", + "type": "string" + } + }, + "required": [ + "name", + "example" + ], + "type": "object" + }, + "withEnter": { + "description": "Boolean to indicate if `Enter` should be pressed at the end of the `typeText` step type.", + "type": "boolean" + }, + "x": { + "description": "Amount to scroll by on the `x` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "Amount to scroll by on the `y` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + } + }, "type": "object" }, "publicId": { @@ -511443,6 +512544,11 @@ ] } }, + "required": [ + "name", + "params", + "type" + ], "type": "object" }, "type": "array" @@ -511479,129 +512585,15 @@ ], "type": "object" }, - "SyntheticsMobileTestBinding": { - "description": "Objects describing the binding used for a mobile test.", - "properties": { - "items": { - "description": "Object describing the binding used for a mobile test.", - "properties": { - "principals": { - "description": "List of principals for a mobile test binding.", - "items": { - "description": "A principal for a mobile test binding.", - "maxLength": 1500, - "type": "string" - }, - "type": "array" - }, - "role": { - "description": "The definition of `SyntheticsMobileTestBindingItemsRole` object.", - "enum": [ - "editor", - "viewer" - ], - "type": "string", - "x-enum-varnames": [ - "EDITOR", - "VIEWER" - ] - } - }, - "type": "object" - } - }, - "type": "object" - }, - "SyntheticsMobileTestBindingItems": { - "description": "Object describing the binding used for a mobile test.", - "properties": { - "principals": { - "description": "List of principals for a mobile test binding.", - "items": { - "description": "A principal for a mobile test binding.", - "maxLength": 1500, - "type": "string" - }, - "type": "array" - }, - "role": { - "description": "The definition of `SyntheticsMobileTestBindingItemsRole` object.", - "enum": [ - "editor", - "viewer" - ], - "type": "string", - "x-enum-varnames": [ - "EDITOR", - "VIEWER" - ] - } - }, - "type": "object" - }, - "SyntheticsMobileTestBindingItemsRole": { - "description": "The definition of `SyntheticsMobileTestBindingItemsRole` object.", - "enum": [ - "editor", - "viewer" - ], - "type": "string", - "x-enum-varnames": [ - "EDITOR", - "VIEWER" - ] - }, - "SyntheticsMobileTestBindingPrincipals": { - "description": "List of principals for a mobile test binding.", - "items": { - "description": "A principal for a mobile test binding.", - "maxLength": 1500, - "type": "string" - }, - "type": "array" - }, - "SyntheticsMobileTestCiOptions": { - "description": "CI/CD options for a Synthetic test.", - "properties": { - "executionRule": { - "description": "Execution rule for a Synthetic test.", - "enum": [ - "blocking", - "non_blocking", - "skipped" - ], - "example": "blocking", - "type": "string", - "x-enum-varnames": [ - "BLOCKING", - "NON_BLOCKING", - "SKIPPED" - ] - } - }, - "required": [ - "executionRule" - ], - "type": "object" - }, "SyntheticsMobileTestConfig": { "description": "Configuration object for a Synthetic mobile test.", "properties": { "initialApplicationArguments": { - "description": "Initial application arguments for a mobile test.", - "properties": { - "propertyNames": { - "description": "Name of the property.", - "properties": { - "pattern": { - "description": "The `propertyNames` `pattern`.", - "example": "^(?!_dd).*$", - "type": "string" - } - }, - "type": "object" - } + "additionalProperties": { + "description": "A single application argument.", + "type": "string" }, + "description": "Initial application arguments for a mobile test.", "type": "object" }, "variables": { @@ -511659,38 +512651,18 @@ "type": "object" }, "SyntheticsMobileTestInitialApplicationArguments": { - "description": "Initial application arguments for a mobile test.", - "properties": { - "propertyNames": { - "description": "Name of the property.", - "properties": { - "pattern": { - "description": "The `propertyNames` `pattern`.", - "example": "^(?!_dd).*$", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "SyntheticsMobileTestInitialApplicationArgumentsPropertyNames": { - "description": "Name of the property.", - "properties": { - "pattern": { - "description": "The `propertyNames` `pattern`.", - "example": "^(?!_dd).*$", - "type": "string" - } + "additionalProperties": { + "description": "A single application argument.", + "type": "string" }, + "description": "Initial application arguments for a mobile test.", "type": "object" }, "SyntheticsMobileTestOptions": { "description": "Object describing the extra options for a Synthetic test.", "properties": { "allowApplicationCrash": { - "description": "The `SyntheticsMobileTestOptions` `allowApplicationCrash`.", + "description": "A boolean to set if an application crash would mark the test as failed.", "type": "boolean" }, "bindings": { @@ -511698,32 +512670,26 @@ "items": { "description": "Objects describing the binding used for a mobile test.", "properties": { - "items": { - "description": "Object describing the binding used for a mobile test.", - "properties": { - "principals": { - "description": "List of principals for a mobile test binding.", - "items": { - "description": "A principal for a mobile test binding.", - "maxLength": 1500, - "type": "string" - }, - "type": "array" - }, - "role": { - "description": "The definition of `SyntheticsMobileTestBindingItemsRole` object.", - "enum": [ - "editor", - "viewer" - ], - "type": "string", - "x-enum-varnames": [ - "EDITOR", - "VIEWER" - ] - } + "principals": { + "description": "List of principals for a mobile test binding.", + "items": { + "description": "A principal for a mobile test binding.", + "maxLength": 1500, + "type": "string" }, - "type": "object" + "type": "array" + }, + "relation": { + "description": "The type of relation for the binding.", + "enum": [ + "editor", + "viewer" + ], + "type": "string", + "x-enum-varnames": [ + "EDITOR", + "VIEWER" + ] } }, "type": "object" @@ -511755,7 +512721,7 @@ "type": "object" }, "defaultStepTimeout": { - "description": "The `SyntheticsMobileTestOptions` `defaultStepTimeout`.", + "description": "The default timeout for steps in the test (in seconds).", "format": "int32", "maximum": 300, "minimum": 1, @@ -511763,6 +512729,9 @@ }, "device_ids": { "description": "For mobile test, array with the different device IDs used to run the test.", + "example": [ + "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16" + ], "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -511771,7 +512740,7 @@ "type": "array" }, "disableAutoAcceptAlert": { - "description": "The `SyntheticsMobileTestOptions` `disableAutoAcceptAlert`.", + "description": "A boolean to disable auto accepting alerts.", "type": "boolean" }, "min_failure_duration": { @@ -511786,11 +512755,13 @@ "properties": { "applicationId": { "description": "Application ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaaa", "maxLength": 1500, "type": "string" }, "referenceId": { "description": "Reference ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaab", "maxLength": 1500, "type": "string" }, @@ -511800,6 +512771,7 @@ "latest", "version" ], + "example": "latest", "type": "string", "x-enum-varnames": [ "LATEST", @@ -511807,6 +512779,11 @@ ] } }, + "required": [ + "applicationId", + "referenceId", + "referenceType" + ], "type": "object" }, "monitor_name": { @@ -511814,14 +512791,14 @@ "type": "string" }, "monitor_options": { - "description": "Object containing the options for a mobile Synthetic test as a monitor\n(for example, renotification).", + "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { "escalation_message": { "description": "Message to include in the escalation notification.", "type": "string" }, "notification_preset_name": { - "description": "The definition of `SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName` object.", + "description": "The name of the preset for the notification for the monitor.", "enum": [ "show_all", "hide_all", @@ -511843,7 +512820,7 @@ "type": "integer" }, "renotify_occurrences": { - "description": "The `SyntheticsMobileTestOptionsMonitorOptions` `renotify_occurrences`.", + "description": "The number of times to renotify if the test is still failing.", "format": "int64", "type": "integer" } @@ -511858,7 +512835,7 @@ "type": "integer" }, "noScreenshot": { - "description": "The `SyntheticsMobileTestOptions` `noScreenshot`.", + "description": "A boolean set to not take a screenshot for the step.", "type": "boolean" }, "restricted_roles": { @@ -511928,6 +512905,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -511938,77 +512920,34 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { "description": "The frequency at which to run the Synthetic test (in seconds).", + "example": 300, "format": "int64", "maximum": 604800, "minimum": 300, "type": "integer" }, "verbosity": { - "description": "The `SyntheticsMobileTestOptions` `verbosity`.", + "description": "The level of verbosity for the mobile test.", "format": "int32", "maximum": 5, "minimum": 0, "type": "integer" } }, - "type": "object" - }, - "SyntheticsMobileTestOptionsMonitorOptions": { - "description": "Object containing the options for a mobile Synthetic test as a monitor\n(for example, renotification).", - "properties": { - "escalation_message": { - "description": "Message to include in the escalation notification.", - "type": "string" - }, - "notification_preset_name": { - "description": "The definition of `SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName` object.", - "enum": [ - "show_all", - "hide_all", - "hide_query", - "hide_handles" - ], - "type": "string", - "x-enum-varnames": [ - "SHOW_ALL", - "HIDE_ALL", - "HIDE_QUERY", - "HIDE_HANDLES" - ] - }, - "renotify_interval": { - "description": "Time interval before renotifying if the test is still failing\n(in minutes).", - "format": "int64", - "minimum": 0, - "type": "integer" - }, - "renotify_occurrences": { - "description": "The `SyntheticsMobileTestOptionsMonitorOptions` `renotify_occurrences`.", - "format": "int64", - "type": "integer" - } - }, - "type": "object" - }, - "SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName": { - "description": "The definition of `SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName` object.", - "enum": [ - "show_all", - "hide_all", - "hide_query", - "hide_handles" + "required": [ + "device_ids", + "tick_every", + "mobileApplication" ], - "type": "string", - "x-enum-varnames": [ - "SHOW_ALL", - "HIDE_ALL", - "HIDE_QUERY", - "HIDE_HANDLES" - ] + "type": "object" }, "SyntheticsMobileTestType": { "default": "mobile", @@ -512027,11 +512966,13 @@ "properties": { "applicationId": { "description": "Application ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaaa", "maxLength": 1500, "type": "string" }, "referenceId": { "description": "Reference ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaab", "maxLength": 1500, "type": "string" }, @@ -512041,6 +512982,7 @@ "latest", "version" ], + "example": "latest", "type": "string", "x-enum-varnames": [ "LATEST", @@ -512048,6 +512990,11 @@ ] } }, + "required": [ + "applicationId", + "referenceId", + "referenceType" + ], "type": "object" }, "SyntheticsMobileTestsMobileApplicationReferenceType": { @@ -512056,6 +513003,7 @@ "latest", "version" ], + "example": "latest", "type": "string", "x-enum-varnames": [ "LATEST", @@ -513333,6 +514281,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "SyntheticsTestConfig": { @@ -515753,6 +516704,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -515853,11 +516807,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -515971,6 +516950,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -515981,6 +516965,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -516278,6 +517266,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -516378,11 +517369,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -516496,6 +517512,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -516506,6 +517527,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -516535,15 +517560,56 @@ "SyntheticsTestOptionsMonitorOptions": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" }, + "SyntheticsTestOptionsMonitorOptionsNotificationPresetName": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "SyntheticsTestOptionsRetry": { "description": "Object describing the retry strategy to apply to a Synthetic test.", "properties": { @@ -516599,6 +517665,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -516609,6 +517680,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "SyntheticsTestOptionsSchedulingTimeframe": { @@ -516633,6 +517708,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "SyntheticsTestPauseStatus": { @@ -517421,6 +518501,54 @@ "description": "String Port number to use when performing the test. Supports templated variables.", "type": "string" }, + "SyntheticsTestRestrictionPolicyBinding": { + "description": "Objects describing the binding used for a mobile test.", + "properties": { + "principals": { + "description": "List of principals for a mobile test binding.", + "items": { + "description": "A principal for a mobile test binding.", + "maxLength": 1500, + "type": "string" + }, + "type": "array" + }, + "relation": { + "description": "The type of relation for the binding.", + "enum": [ + "editor", + "viewer" + ], + "type": "string", + "x-enum-varnames": [ + "EDITOR", + "VIEWER" + ] + } + }, + "type": "object" + }, + "SyntheticsTestRestrictionPolicyBindingPrincipals": { + "description": "List of principals for a mobile test binding.", + "items": { + "description": "A principal for a mobile test binding.", + "maxLength": 1500, + "type": "string" + }, + "type": "array" + }, + "SyntheticsTestRestrictionPolicyBindingRelation": { + "description": "The type of relation for the binding.", + "enum": [ + "editor", + "viewer" + ], + "type": "string", + "x-enum-varnames": [ + "EDITOR", + "VIEWER" + ] + }, "SyntheticsTestUptime": { "description": "Object containing the uptime for a Synthetic test ID.", "properties": { @@ -1071113,6 +1072241,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1071213,11 +1072344,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1071331,6 +1072487,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1071341,6 +1072502,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1072899,6 +1074064,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1072999,11 +1074167,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1073117,6 +1074310,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1073127,6 +1074325,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1074562,6 +1075764,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1074662,11 +1075867,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1074780,6 +1076010,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1074790,6 +1076025,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1077727,6 +1078966,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1077827,11 +1079069,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1077945,6 +1079212,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1077955,6 +1079227,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1080497,6 +1081773,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1080597,11 +1081876,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1080715,6 +1082019,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1080725,6 +1082034,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1083458,6 +1084771,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1083558,11 +1084874,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1083676,6 +1085017,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1083686,6 +1085032,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1086351,6 +1087701,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1086451,11 +1087804,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1086569,6 +1087947,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1086579,6 +1087962,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1089121,6 +1090508,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1089221,11 +1090611,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1089339,6 +1090754,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1089349,6 +1090769,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1090833,6 +1092257,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1090933,11 +1092360,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1091051,6 +1092503,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1091061,6 +1092518,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1092468,6 +1093929,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1092568,11 +1094032,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1092686,6 +1094175,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1092696,6 +1094190,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1094265,6 +1095763,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1094365,11 +1095866,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1094483,6 +1096009,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1094493,6 +1096024,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1096023,6 +1097558,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1096123,11 +1097661,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1096241,6 +1097804,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1096251,6 +1097819,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1097658,6 +1099230,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1097758,11 +1099333,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1097876,6 +1099476,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1097886,6 +1099491,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1100633,20 +1102242,11 @@ "description": "Configuration object for a Synthetic mobile test.", "properties": { "initialApplicationArguments": { - "description": "Initial application arguments for a mobile test.", - "properties": { - "propertyNames": { - "description": "Name of the property.", - "properties": { - "pattern": { - "description": "The `propertyNames` `pattern`.", - "example": "^(?!_dd).*$", - "type": "string" - } - }, - "type": "object" - } + "additionalProperties": { + "description": "A single application argument.", + "type": "string" }, + "description": "Initial application arguments for a mobile test.", "type": "object" }, "variables": { @@ -1100704,7 +1102304,7 @@ "type": "object" }, "device_ids": { - "description": "The `SyntheticsMobileTest` `device_ids`.", + "description": "Array with the different device IDs used to run the test.", "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -1100733,7 +1102333,7 @@ "description": "Object describing the extra options for a Synthetic test.", "properties": { "allowApplicationCrash": { - "description": "The `SyntheticsMobileTestOptions` `allowApplicationCrash`.", + "description": "A boolean to set if an application crash would mark the test as failed.", "type": "boolean" }, "bindings": { @@ -1100741,32 +1102341,26 @@ "items": { "description": "Objects describing the binding used for a mobile test.", "properties": { - "items": { - "description": "Object describing the binding used for a mobile test.", - "properties": { - "principals": { - "description": "List of principals for a mobile test binding.", - "items": { - "description": "A principal for a mobile test binding.", - "maxLength": 1500, - "type": "string" - }, - "type": "array" - }, - "role": { - "description": "The definition of `SyntheticsMobileTestBindingItemsRole` object.", - "enum": [ - "editor", - "viewer" - ], - "type": "string", - "x-enum-varnames": [ - "EDITOR", - "VIEWER" - ] - } + "principals": { + "description": "List of principals for a mobile test binding.", + "items": { + "description": "A principal for a mobile test binding.", + "maxLength": 1500, + "type": "string" }, - "type": "object" + "type": "array" + }, + "relation": { + "description": "The type of relation for the binding.", + "enum": [ + "editor", + "viewer" + ], + "type": "string", + "x-enum-varnames": [ + "EDITOR", + "VIEWER" + ] } }, "type": "object" @@ -1100798,7 +1102392,7 @@ "type": "object" }, "defaultStepTimeout": { - "description": "The `SyntheticsMobileTestOptions` `defaultStepTimeout`.", + "description": "The default timeout for steps in the test (in seconds).", "format": "int32", "maximum": 300, "minimum": 1, @@ -1100806,6 +1102400,9 @@ }, "device_ids": { "description": "For mobile test, array with the different device IDs used to run the test.", + "example": [ + "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16" + ], "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -1100814,7 +1102411,7 @@ "type": "array" }, "disableAutoAcceptAlert": { - "description": "The `SyntheticsMobileTestOptions` `disableAutoAcceptAlert`.", + "description": "A boolean to disable auto accepting alerts.", "type": "boolean" }, "min_failure_duration": { @@ -1100829,11 +1102426,13 @@ "properties": { "applicationId": { "description": "Application ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaaa", "maxLength": 1500, "type": "string" }, "referenceId": { "description": "Reference ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaab", "maxLength": 1500, "type": "string" }, @@ -1100843,6 +1102442,7 @@ "latest", "version" ], + "example": "latest", "type": "string", "x-enum-varnames": [ "LATEST", @@ -1100850,6 +1102450,11 @@ ] } }, + "required": [ + "applicationId", + "referenceId", + "referenceType" + ], "type": "object" }, "monitor_name": { @@ -1100857,14 +1102462,14 @@ "type": "string" }, "monitor_options": { - "description": "Object containing the options for a mobile Synthetic test as a monitor\n(for example, renotification).", + "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { "escalation_message": { "description": "Message to include in the escalation notification.", "type": "string" }, "notification_preset_name": { - "description": "The definition of `SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName` object.", + "description": "The name of the preset for the notification for the monitor.", "enum": [ "show_all", "hide_all", @@ -1100886,7 +1102491,7 @@ "type": "integer" }, "renotify_occurrences": { - "description": "The `SyntheticsMobileTestOptionsMonitorOptions` `renotify_occurrences`.", + "description": "The number of times to renotify if the test is still failing.", "format": "int64", "type": "integer" } @@ -1100901,7 +1102506,7 @@ "type": "integer" }, "noScreenshot": { - "description": "The `SyntheticsMobileTestOptions` `noScreenshot`.", + "description": "A boolean set to not take a screenshot for the step.", "type": "boolean" }, "restricted_roles": { @@ -1100971,6 +1102576,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1100981,23 +1102591,33 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { "description": "The frequency at which to run the Synthetic test (in seconds).", + "example": 300, "format": "int64", "maximum": 604800, "minimum": 300, "type": "integer" }, "verbosity": { - "description": "The `SyntheticsMobileTestOptions` `verbosity`.", + "description": "The level of verbosity for the mobile test.", "format": "int32", "maximum": 5, "minimum": 0, "type": "integer" } }, + "required": [ + "device_ids", + "tick_every", + "mobileApplication" + ], "type": "object" }, "public_id": { @@ -1101038,6 +1102658,7 @@ }, "name": { "description": "The name of the step.", + "example": "", "maxLength": 1500, "type": "string" }, @@ -1101046,7 +1102667,235 @@ "type": "boolean" }, "params": { - "description": "The parameters of the mobile step.", + "description": "The parameters of a mobile step.", + "properties": { + "check": { + "description": "Type of assertion to apply in an API test.", + "enum": [ + "equals", + "notEquals", + "contains", + "notContains", + "startsWith", + "notStartsWith", + "greater", + "lower", + "greaterEquals", + "lowerEquals", + "matchRegex", + "between", + "isEmpty", + "notIsEmpty" + ], + "type": "string", + "x-enum-varnames": [ + "EQUALS", + "NOT_EQUALS", + "CONTAINS", + "NOT_CONTAINS", + "STARTS_WITH", + "NOT_STARTS_WITH", + "GREATER", + "LOWER", + "GREATER_EQUALS", + "LOWER_EQUALS", + "MATCH_REGEX", + "BETWEEN", + "IS_EMPTY", + "NOT_IS_EMPTY" + ] + }, + "delay": { + "description": "Number of milliseconds to wait between inputs in a `typeText` step type.", + "format": "int64", + "maximum": 5000, + "minimum": 0, + "type": "integer" + }, + "direction": { + "description": "The direction of the scroll for a `scrollToElement` step type.", + "enum": [ + "up", + "down", + "left", + "right" + ], + "type": "string", + "x-enum-varnames": [ + "UP", + "DOWN", + "LEFT", + "RIGHT" + ] + }, + "element": { + "description": "Information about the element used for a step.", + "properties": { + "context": { + "description": "Context of the element.", + "type": "string" + }, + "contextType": { + "description": "Type of the context that the element is in.", + "enum": [ + "native", + "web" + ], + "type": "string", + "x-enum-varnames": [ + "NATIVE", + "WEB" + ] + }, + "elementDescription": { + "description": "Description of the element.", + "type": "string" + }, + "multiLocator": { + "description": "Multi-locator to find the element.", + "type": "object" + }, + "relativePosition": { + "description": "Position of the action relative to the element.", + "properties": { + "x": { + "description": "The `relativePosition` on the `x` axis for the element.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `relativePosition` on the `y` axis for the element.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "textContent": { + "description": "Text content of the element.", + "type": "string" + }, + "userLocator": { + "description": "User locator to find the element.", + "properties": { + "failTestOnCannotLocate": { + "description": "Whether if the the test should fail if the element cannot be found.", + "type": "boolean" + }, + "values": { + "description": "Values of the user locator.", + "items": { + "description": "A single user locator object.", + "properties": { + "type": { + "description": "Type of a user locator.", + "enum": [ + "accessibility-id", + "id", + "ios-predicate-string", + "ios-class-chain", + "xpath" + ], + "type": "string", + "x-enum-varnames": [ + "ACCESSIBILITY_ID", + "ID", + "IOS_PREDICATE_STRING", + "IOS_CLASS_CHAIN", + "XPATH" + ] + }, + "value": { + "description": "Value of a user locator.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "viewName": { + "description": "Name of the view of the element.", + "type": "string" + } + }, + "type": "object" + }, + "enable": { + "description": "Boolean to change the state of the wifi for a `toggleWiFi` step type.", + "type": "boolean" + }, + "maxScrolls": { + "description": "Maximum number of scrolls to do for a `scrollToElement` step type.", + "format": "int64", + "type": "integer" + }, + "positions": { + "description": "List of positions for the `flick` step type. The maximum is 10 flicks per step", + "items": { + "description": "A description of a single position for a `flick` step type.", + "properties": { + "x": { + "description": "The `x` position for the flick.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `y` position for the flick.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "subtestPublicId": { + "description": "Public ID of the test to be played as part of a `playSubTest` step type.", + "type": "string" + }, + "value": { + "description": "Values used in the step. Used in multiple step types.", + "type": "string" + }, + "variable": { + "description": "Variable object for `extractVariable` step type.", + "properties": { + "example": { + "description": "An example for the variable.", + "example": "", + "type": "string" + }, + "name": { + "description": "The variable name.", + "example": "VAR_NAME", + "type": "string" + } + }, + "required": [ + "name", + "example" + ], + "type": "object" + }, + "withEnter": { + "description": "Boolean to indicate if `Enter` should be pressed at the end of the `typeText` step type.", + "type": "boolean" + }, + "x": { + "description": "Amount to scroll by on the `x` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "Amount to scroll by on the `y` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + } + }, "type": "object" }, "publicId": { @@ -1101103,6 +1102952,11 @@ ] } }, + "required": [ + "name", + "params", + "type" + ], "type": "object" }, "type": "array" @@ -1101155,20 +1103009,11 @@ "description": "Configuration object for a Synthetic mobile test.", "properties": { "initialApplicationArguments": { - "description": "Initial application arguments for a mobile test.", - "properties": { - "propertyNames": { - "description": "Name of the property.", - "properties": { - "pattern": { - "description": "The `propertyNames` `pattern`.", - "example": "^(?!_dd).*$", - "type": "string" - } - }, - "type": "object" - } + "additionalProperties": { + "description": "A single application argument.", + "type": "string" }, + "description": "Initial application arguments for a mobile test.", "type": "object" }, "variables": { @@ -1101226,7 +1103071,7 @@ "type": "object" }, "device_ids": { - "description": "The `SyntheticsMobileTest` `device_ids`.", + "description": "Array with the different device IDs used to run the test.", "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -1101255,7 +1103100,7 @@ "description": "Object describing the extra options for a Synthetic test.", "properties": { "allowApplicationCrash": { - "description": "The `SyntheticsMobileTestOptions` `allowApplicationCrash`.", + "description": "A boolean to set if an application crash would mark the test as failed.", "type": "boolean" }, "bindings": { @@ -1101263,32 +1103108,26 @@ "items": { "description": "Objects describing the binding used for a mobile test.", "properties": { - "items": { - "description": "Object describing the binding used for a mobile test.", - "properties": { - "principals": { - "description": "List of principals for a mobile test binding.", - "items": { - "description": "A principal for a mobile test binding.", - "maxLength": 1500, - "type": "string" - }, - "type": "array" - }, - "role": { - "description": "The definition of `SyntheticsMobileTestBindingItemsRole` object.", - "enum": [ - "editor", - "viewer" - ], - "type": "string", - "x-enum-varnames": [ - "EDITOR", - "VIEWER" - ] - } + "principals": { + "description": "List of principals for a mobile test binding.", + "items": { + "description": "A principal for a mobile test binding.", + "maxLength": 1500, + "type": "string" }, - "type": "object" + "type": "array" + }, + "relation": { + "description": "The type of relation for the binding.", + "enum": [ + "editor", + "viewer" + ], + "type": "string", + "x-enum-varnames": [ + "EDITOR", + "VIEWER" + ] } }, "type": "object" @@ -1101320,7 +1103159,7 @@ "type": "object" }, "defaultStepTimeout": { - "description": "The `SyntheticsMobileTestOptions` `defaultStepTimeout`.", + "description": "The default timeout for steps in the test (in seconds).", "format": "int32", "maximum": 300, "minimum": 1, @@ -1101328,6 +1103167,9 @@ }, "device_ids": { "description": "For mobile test, array with the different device IDs used to run the test.", + "example": [ + "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16" + ], "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -1101336,7 +1103178,7 @@ "type": "array" }, "disableAutoAcceptAlert": { - "description": "The `SyntheticsMobileTestOptions` `disableAutoAcceptAlert`.", + "description": "A boolean to disable auto accepting alerts.", "type": "boolean" }, "min_failure_duration": { @@ -1101351,11 +1103193,13 @@ "properties": { "applicationId": { "description": "Application ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaaa", "maxLength": 1500, "type": "string" }, "referenceId": { "description": "Reference ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaab", "maxLength": 1500, "type": "string" }, @@ -1101365,6 +1103209,7 @@ "latest", "version" ], + "example": "latest", "type": "string", "x-enum-varnames": [ "LATEST", @@ -1101372,6 +1103217,11 @@ ] } }, + "required": [ + "applicationId", + "referenceId", + "referenceType" + ], "type": "object" }, "monitor_name": { @@ -1101379,14 +1103229,14 @@ "type": "string" }, "monitor_options": { - "description": "Object containing the options for a mobile Synthetic test as a monitor\n(for example, renotification).", + "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { "escalation_message": { "description": "Message to include in the escalation notification.", "type": "string" }, "notification_preset_name": { - "description": "The definition of `SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName` object.", + "description": "The name of the preset for the notification for the monitor.", "enum": [ "show_all", "hide_all", @@ -1101408,7 +1103258,7 @@ "type": "integer" }, "renotify_occurrences": { - "description": "The `SyntheticsMobileTestOptionsMonitorOptions` `renotify_occurrences`.", + "description": "The number of times to renotify if the test is still failing.", "format": "int64", "type": "integer" } @@ -1101423,7 +1103273,7 @@ "type": "integer" }, "noScreenshot": { - "description": "The `SyntheticsMobileTestOptions` `noScreenshot`.", + "description": "A boolean set to not take a screenshot for the step.", "type": "boolean" }, "restricted_roles": { @@ -1101493,6 +1103343,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1101503,23 +1103358,33 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { "description": "The frequency at which to run the Synthetic test (in seconds).", + "example": 300, "format": "int64", "maximum": 604800, "minimum": 300, "type": "integer" }, "verbosity": { - "description": "The `SyntheticsMobileTestOptions` `verbosity`.", + "description": "The level of verbosity for the mobile test.", "format": "int32", "maximum": 5, "minimum": 0, "type": "integer" } }, + "required": [ + "device_ids", + "tick_every", + "mobileApplication" + ], "type": "object" }, "public_id": { @@ -1101560,6 +1103425,7 @@ }, "name": { "description": "The name of the step.", + "example": "", "maxLength": 1500, "type": "string" }, @@ -1101568,7 +1103434,235 @@ "type": "boolean" }, "params": { - "description": "The parameters of the mobile step.", + "description": "The parameters of a mobile step.", + "properties": { + "check": { + "description": "Type of assertion to apply in an API test.", + "enum": [ + "equals", + "notEquals", + "contains", + "notContains", + "startsWith", + "notStartsWith", + "greater", + "lower", + "greaterEquals", + "lowerEquals", + "matchRegex", + "between", + "isEmpty", + "notIsEmpty" + ], + "type": "string", + "x-enum-varnames": [ + "EQUALS", + "NOT_EQUALS", + "CONTAINS", + "NOT_CONTAINS", + "STARTS_WITH", + "NOT_STARTS_WITH", + "GREATER", + "LOWER", + "GREATER_EQUALS", + "LOWER_EQUALS", + "MATCH_REGEX", + "BETWEEN", + "IS_EMPTY", + "NOT_IS_EMPTY" + ] + }, + "delay": { + "description": "Number of milliseconds to wait between inputs in a `typeText` step type.", + "format": "int64", + "maximum": 5000, + "minimum": 0, + "type": "integer" + }, + "direction": { + "description": "The direction of the scroll for a `scrollToElement` step type.", + "enum": [ + "up", + "down", + "left", + "right" + ], + "type": "string", + "x-enum-varnames": [ + "UP", + "DOWN", + "LEFT", + "RIGHT" + ] + }, + "element": { + "description": "Information about the element used for a step.", + "properties": { + "context": { + "description": "Context of the element.", + "type": "string" + }, + "contextType": { + "description": "Type of the context that the element is in.", + "enum": [ + "native", + "web" + ], + "type": "string", + "x-enum-varnames": [ + "NATIVE", + "WEB" + ] + }, + "elementDescription": { + "description": "Description of the element.", + "type": "string" + }, + "multiLocator": { + "description": "Multi-locator to find the element.", + "type": "object" + }, + "relativePosition": { + "description": "Position of the action relative to the element.", + "properties": { + "x": { + "description": "The `relativePosition` on the `x` axis for the element.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `relativePosition` on the `y` axis for the element.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "textContent": { + "description": "Text content of the element.", + "type": "string" + }, + "userLocator": { + "description": "User locator to find the element.", + "properties": { + "failTestOnCannotLocate": { + "description": "Whether if the the test should fail if the element cannot be found.", + "type": "boolean" + }, + "values": { + "description": "Values of the user locator.", + "items": { + "description": "A single user locator object.", + "properties": { + "type": { + "description": "Type of a user locator.", + "enum": [ + "accessibility-id", + "id", + "ios-predicate-string", + "ios-class-chain", + "xpath" + ], + "type": "string", + "x-enum-varnames": [ + "ACCESSIBILITY_ID", + "ID", + "IOS_PREDICATE_STRING", + "IOS_CLASS_CHAIN", + "XPATH" + ] + }, + "value": { + "description": "Value of a user locator.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "viewName": { + "description": "Name of the view of the element.", + "type": "string" + } + }, + "type": "object" + }, + "enable": { + "description": "Boolean to change the state of the wifi for a `toggleWiFi` step type.", + "type": "boolean" + }, + "maxScrolls": { + "description": "Maximum number of scrolls to do for a `scrollToElement` step type.", + "format": "int64", + "type": "integer" + }, + "positions": { + "description": "List of positions for the `flick` step type. The maximum is 10 flicks per step", + "items": { + "description": "A description of a single position for a `flick` step type.", + "properties": { + "x": { + "description": "The `x` position for the flick.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `y` position for the flick.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "subtestPublicId": { + "description": "Public ID of the test to be played as part of a `playSubTest` step type.", + "type": "string" + }, + "value": { + "description": "Values used in the step. Used in multiple step types.", + "type": "string" + }, + "variable": { + "description": "Variable object for `extractVariable` step type.", + "properties": { + "example": { + "description": "An example for the variable.", + "example": "", + "type": "string" + }, + "name": { + "description": "The variable name.", + "example": "VAR_NAME", + "type": "string" + } + }, + "required": [ + "name", + "example" + ], + "type": "object" + }, + "withEnter": { + "description": "Boolean to indicate if `Enter` should be pressed at the end of the `typeText` step type.", + "type": "boolean" + }, + "x": { + "description": "Amount to scroll by on the `x` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "Amount to scroll by on the `y` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + } + }, "type": "object" }, "publicId": { @@ -1101625,6 +1103719,11 @@ ] } }, + "required": [ + "name", + "params", + "type" + ], "type": "object" }, "type": "array" @@ -1101844,20 +1103943,11 @@ "description": "Configuration object for a Synthetic mobile test.", "properties": { "initialApplicationArguments": { - "description": "Initial application arguments for a mobile test.", - "properties": { - "propertyNames": { - "description": "Name of the property.", - "properties": { - "pattern": { - "description": "The `propertyNames` `pattern`.", - "example": "^(?!_dd).*$", - "type": "string" - } - }, - "type": "object" - } + "additionalProperties": { + "description": "A single application argument.", + "type": "string" }, + "description": "Initial application arguments for a mobile test.", "type": "object" }, "variables": { @@ -1101915,7 +1104005,7 @@ "type": "object" }, "device_ids": { - "description": "The `SyntheticsMobileTest` `device_ids`.", + "description": "Array with the different device IDs used to run the test.", "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -1101944,7 +1104034,7 @@ "description": "Object describing the extra options for a Synthetic test.", "properties": { "allowApplicationCrash": { - "description": "The `SyntheticsMobileTestOptions` `allowApplicationCrash`.", + "description": "A boolean to set if an application crash would mark the test as failed.", "type": "boolean" }, "bindings": { @@ -1101952,32 +1104042,26 @@ "items": { "description": "Objects describing the binding used for a mobile test.", "properties": { - "items": { - "description": "Object describing the binding used for a mobile test.", - "properties": { - "principals": { - "description": "List of principals for a mobile test binding.", - "items": { - "description": "A principal for a mobile test binding.", - "maxLength": 1500, - "type": "string" - }, - "type": "array" - }, - "role": { - "description": "The definition of `SyntheticsMobileTestBindingItemsRole` object.", - "enum": [ - "editor", - "viewer" - ], - "type": "string", - "x-enum-varnames": [ - "EDITOR", - "VIEWER" - ] - } + "principals": { + "description": "List of principals for a mobile test binding.", + "items": { + "description": "A principal for a mobile test binding.", + "maxLength": 1500, + "type": "string" }, - "type": "object" + "type": "array" + }, + "relation": { + "description": "The type of relation for the binding.", + "enum": [ + "editor", + "viewer" + ], + "type": "string", + "x-enum-varnames": [ + "EDITOR", + "VIEWER" + ] } }, "type": "object" @@ -1102009,7 +1104093,7 @@ "type": "object" }, "defaultStepTimeout": { - "description": "The `SyntheticsMobileTestOptions` `defaultStepTimeout`.", + "description": "The default timeout for steps in the test (in seconds).", "format": "int32", "maximum": 300, "minimum": 1, @@ -1102017,6 +1104101,9 @@ }, "device_ids": { "description": "For mobile test, array with the different device IDs used to run the test.", + "example": [ + "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16" + ], "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -1102025,7 +1104112,7 @@ "type": "array" }, "disableAutoAcceptAlert": { - "description": "The `SyntheticsMobileTestOptions` `disableAutoAcceptAlert`.", + "description": "A boolean to disable auto accepting alerts.", "type": "boolean" }, "min_failure_duration": { @@ -1102040,11 +1104127,13 @@ "properties": { "applicationId": { "description": "Application ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaaa", "maxLength": 1500, "type": "string" }, "referenceId": { "description": "Reference ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaab", "maxLength": 1500, "type": "string" }, @@ -1102054,6 +1104143,7 @@ "latest", "version" ], + "example": "latest", "type": "string", "x-enum-varnames": [ "LATEST", @@ -1102061,6 +1104151,11 @@ ] } }, + "required": [ + "applicationId", + "referenceId", + "referenceType" + ], "type": "object" }, "monitor_name": { @@ -1102068,14 +1104163,14 @@ "type": "string" }, "monitor_options": { - "description": "Object containing the options for a mobile Synthetic test as a monitor\n(for example, renotification).", + "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { "escalation_message": { "description": "Message to include in the escalation notification.", "type": "string" }, "notification_preset_name": { - "description": "The definition of `SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName` object.", + "description": "The name of the preset for the notification for the monitor.", "enum": [ "show_all", "hide_all", @@ -1102097,7 +1104192,7 @@ "type": "integer" }, "renotify_occurrences": { - "description": "The `SyntheticsMobileTestOptionsMonitorOptions` `renotify_occurrences`.", + "description": "The number of times to renotify if the test is still failing.", "format": "int64", "type": "integer" } @@ -1102112,7 +1104207,7 @@ "type": "integer" }, "noScreenshot": { - "description": "The `SyntheticsMobileTestOptions` `noScreenshot`.", + "description": "A boolean set to not take a screenshot for the step.", "type": "boolean" }, "restricted_roles": { @@ -1102182,6 +1104277,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1102192,23 +1104292,33 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { "description": "The frequency at which to run the Synthetic test (in seconds).", + "example": 300, "format": "int64", "maximum": 604800, "minimum": 300, "type": "integer" }, "verbosity": { - "description": "The `SyntheticsMobileTestOptions` `verbosity`.", + "description": "The level of verbosity for the mobile test.", "format": "int32", "maximum": 5, "minimum": 0, "type": "integer" } }, + "required": [ + "device_ids", + "tick_every", + "mobileApplication" + ], "type": "object" }, "public_id": { @@ -1102249,6 +1104359,7 @@ }, "name": { "description": "The name of the step.", + "example": "", "maxLength": 1500, "type": "string" }, @@ -1102257,7 +1104368,235 @@ "type": "boolean" }, "params": { - "description": "The parameters of the mobile step.", + "description": "The parameters of a mobile step.", + "properties": { + "check": { + "description": "Type of assertion to apply in an API test.", + "enum": [ + "equals", + "notEquals", + "contains", + "notContains", + "startsWith", + "notStartsWith", + "greater", + "lower", + "greaterEquals", + "lowerEquals", + "matchRegex", + "between", + "isEmpty", + "notIsEmpty" + ], + "type": "string", + "x-enum-varnames": [ + "EQUALS", + "NOT_EQUALS", + "CONTAINS", + "NOT_CONTAINS", + "STARTS_WITH", + "NOT_STARTS_WITH", + "GREATER", + "LOWER", + "GREATER_EQUALS", + "LOWER_EQUALS", + "MATCH_REGEX", + "BETWEEN", + "IS_EMPTY", + "NOT_IS_EMPTY" + ] + }, + "delay": { + "description": "Number of milliseconds to wait between inputs in a `typeText` step type.", + "format": "int64", + "maximum": 5000, + "minimum": 0, + "type": "integer" + }, + "direction": { + "description": "The direction of the scroll for a `scrollToElement` step type.", + "enum": [ + "up", + "down", + "left", + "right" + ], + "type": "string", + "x-enum-varnames": [ + "UP", + "DOWN", + "LEFT", + "RIGHT" + ] + }, + "element": { + "description": "Information about the element used for a step.", + "properties": { + "context": { + "description": "Context of the element.", + "type": "string" + }, + "contextType": { + "description": "Type of the context that the element is in.", + "enum": [ + "native", + "web" + ], + "type": "string", + "x-enum-varnames": [ + "NATIVE", + "WEB" + ] + }, + "elementDescription": { + "description": "Description of the element.", + "type": "string" + }, + "multiLocator": { + "description": "Multi-locator to find the element.", + "type": "object" + }, + "relativePosition": { + "description": "Position of the action relative to the element.", + "properties": { + "x": { + "description": "The `relativePosition` on the `x` axis for the element.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `relativePosition` on the `y` axis for the element.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "textContent": { + "description": "Text content of the element.", + "type": "string" + }, + "userLocator": { + "description": "User locator to find the element.", + "properties": { + "failTestOnCannotLocate": { + "description": "Whether if the the test should fail if the element cannot be found.", + "type": "boolean" + }, + "values": { + "description": "Values of the user locator.", + "items": { + "description": "A single user locator object.", + "properties": { + "type": { + "description": "Type of a user locator.", + "enum": [ + "accessibility-id", + "id", + "ios-predicate-string", + "ios-class-chain", + "xpath" + ], + "type": "string", + "x-enum-varnames": [ + "ACCESSIBILITY_ID", + "ID", + "IOS_PREDICATE_STRING", + "IOS_CLASS_CHAIN", + "XPATH" + ] + }, + "value": { + "description": "Value of a user locator.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "viewName": { + "description": "Name of the view of the element.", + "type": "string" + } + }, + "type": "object" + }, + "enable": { + "description": "Boolean to change the state of the wifi for a `toggleWiFi` step type.", + "type": "boolean" + }, + "maxScrolls": { + "description": "Maximum number of scrolls to do for a `scrollToElement` step type.", + "format": "int64", + "type": "integer" + }, + "positions": { + "description": "List of positions for the `flick` step type. The maximum is 10 flicks per step", + "items": { + "description": "A description of a single position for a `flick` step type.", + "properties": { + "x": { + "description": "The `x` position for the flick.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `y` position for the flick.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "subtestPublicId": { + "description": "Public ID of the test to be played as part of a `playSubTest` step type.", + "type": "string" + }, + "value": { + "description": "Values used in the step. Used in multiple step types.", + "type": "string" + }, + "variable": { + "description": "Variable object for `extractVariable` step type.", + "properties": { + "example": { + "description": "An example for the variable.", + "example": "", + "type": "string" + }, + "name": { + "description": "The variable name.", + "example": "VAR_NAME", + "type": "string" + } + }, + "required": [ + "name", + "example" + ], + "type": "object" + }, + "withEnter": { + "description": "Boolean to indicate if `Enter` should be pressed at the end of the `typeText` step type.", + "type": "boolean" + }, + "x": { + "description": "Amount to scroll by on the `x` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "Amount to scroll by on the `y` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + } + }, "type": "object" }, "publicId": { @@ -1102314,6 +1104653,11 @@ ] } }, + "required": [ + "name", + "params", + "type" + ], "type": "object" }, "type": "array" @@ -1102483,20 +1104827,11 @@ "description": "Configuration object for a Synthetic mobile test.", "properties": { "initialApplicationArguments": { - "description": "Initial application arguments for a mobile test.", - "properties": { - "propertyNames": { - "description": "Name of the property.", - "properties": { - "pattern": { - "description": "The `propertyNames` `pattern`.", - "example": "^(?!_dd).*$", - "type": "string" - } - }, - "type": "object" - } + "additionalProperties": { + "description": "A single application argument.", + "type": "string" }, + "description": "Initial application arguments for a mobile test.", "type": "object" }, "variables": { @@ -1102554,7 +1104889,7 @@ "type": "object" }, "device_ids": { - "description": "The `SyntheticsMobileTest` `device_ids`.", + "description": "Array with the different device IDs used to run the test.", "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -1102583,7 +1104918,7 @@ "description": "Object describing the extra options for a Synthetic test.", "properties": { "allowApplicationCrash": { - "description": "The `SyntheticsMobileTestOptions` `allowApplicationCrash`.", + "description": "A boolean to set if an application crash would mark the test as failed.", "type": "boolean" }, "bindings": { @@ -1102591,32 +1104926,26 @@ "items": { "description": "Objects describing the binding used for a mobile test.", "properties": { - "items": { - "description": "Object describing the binding used for a mobile test.", - "properties": { - "principals": { - "description": "List of principals for a mobile test binding.", - "items": { - "description": "A principal for a mobile test binding.", - "maxLength": 1500, - "type": "string" - }, - "type": "array" - }, - "role": { - "description": "The definition of `SyntheticsMobileTestBindingItemsRole` object.", - "enum": [ - "editor", - "viewer" - ], - "type": "string", - "x-enum-varnames": [ - "EDITOR", - "VIEWER" - ] - } + "principals": { + "description": "List of principals for a mobile test binding.", + "items": { + "description": "A principal for a mobile test binding.", + "maxLength": 1500, + "type": "string" }, - "type": "object" + "type": "array" + }, + "relation": { + "description": "The type of relation for the binding.", + "enum": [ + "editor", + "viewer" + ], + "type": "string", + "x-enum-varnames": [ + "EDITOR", + "VIEWER" + ] } }, "type": "object" @@ -1102648,7 +1104977,7 @@ "type": "object" }, "defaultStepTimeout": { - "description": "The `SyntheticsMobileTestOptions` `defaultStepTimeout`.", + "description": "The default timeout for steps in the test (in seconds).", "format": "int32", "maximum": 300, "minimum": 1, @@ -1102656,6 +1104985,9 @@ }, "device_ids": { "description": "For mobile test, array with the different device IDs used to run the test.", + "example": [ + "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16" + ], "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -1102664,7 +1104996,7 @@ "type": "array" }, "disableAutoAcceptAlert": { - "description": "The `SyntheticsMobileTestOptions` `disableAutoAcceptAlert`.", + "description": "A boolean to disable auto accepting alerts.", "type": "boolean" }, "min_failure_duration": { @@ -1102679,11 +1105011,13 @@ "properties": { "applicationId": { "description": "Application ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaaa", "maxLength": 1500, "type": "string" }, "referenceId": { "description": "Reference ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaab", "maxLength": 1500, "type": "string" }, @@ -1102693,6 +1105027,7 @@ "latest", "version" ], + "example": "latest", "type": "string", "x-enum-varnames": [ "LATEST", @@ -1102700,6 +1105035,11 @@ ] } }, + "required": [ + "applicationId", + "referenceId", + "referenceType" + ], "type": "object" }, "monitor_name": { @@ -1102707,14 +1105047,14 @@ "type": "string" }, "monitor_options": { - "description": "Object containing the options for a mobile Synthetic test as a monitor\n(for example, renotification).", + "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { "escalation_message": { "description": "Message to include in the escalation notification.", "type": "string" }, "notification_preset_name": { - "description": "The definition of `SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName` object.", + "description": "The name of the preset for the notification for the monitor.", "enum": [ "show_all", "hide_all", @@ -1102736,7 +1105076,7 @@ "type": "integer" }, "renotify_occurrences": { - "description": "The `SyntheticsMobileTestOptionsMonitorOptions` `renotify_occurrences`.", + "description": "The number of times to renotify if the test is still failing.", "format": "int64", "type": "integer" } @@ -1102751,7 +1105091,7 @@ "type": "integer" }, "noScreenshot": { - "description": "The `SyntheticsMobileTestOptions` `noScreenshot`.", + "description": "A boolean set to not take a screenshot for the step.", "type": "boolean" }, "restricted_roles": { @@ -1102821,6 +1105161,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1102831,23 +1105176,33 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { "description": "The frequency at which to run the Synthetic test (in seconds).", + "example": 300, "format": "int64", "maximum": 604800, "minimum": 300, "type": "integer" }, "verbosity": { - "description": "The `SyntheticsMobileTestOptions` `verbosity`.", + "description": "The level of verbosity for the mobile test.", "format": "int32", "maximum": 5, "minimum": 0, "type": "integer" } }, + "required": [ + "device_ids", + "tick_every", + "mobileApplication" + ], "type": "object" }, "public_id": { @@ -1102888,6 +1105243,7 @@ }, "name": { "description": "The name of the step.", + "example": "", "maxLength": 1500, "type": "string" }, @@ -1102896,7 +1105252,235 @@ "type": "boolean" }, "params": { - "description": "The parameters of the mobile step.", + "description": "The parameters of a mobile step.", + "properties": { + "check": { + "description": "Type of assertion to apply in an API test.", + "enum": [ + "equals", + "notEquals", + "contains", + "notContains", + "startsWith", + "notStartsWith", + "greater", + "lower", + "greaterEquals", + "lowerEquals", + "matchRegex", + "between", + "isEmpty", + "notIsEmpty" + ], + "type": "string", + "x-enum-varnames": [ + "EQUALS", + "NOT_EQUALS", + "CONTAINS", + "NOT_CONTAINS", + "STARTS_WITH", + "NOT_STARTS_WITH", + "GREATER", + "LOWER", + "GREATER_EQUALS", + "LOWER_EQUALS", + "MATCH_REGEX", + "BETWEEN", + "IS_EMPTY", + "NOT_IS_EMPTY" + ] + }, + "delay": { + "description": "Number of milliseconds to wait between inputs in a `typeText` step type.", + "format": "int64", + "maximum": 5000, + "minimum": 0, + "type": "integer" + }, + "direction": { + "description": "The direction of the scroll for a `scrollToElement` step type.", + "enum": [ + "up", + "down", + "left", + "right" + ], + "type": "string", + "x-enum-varnames": [ + "UP", + "DOWN", + "LEFT", + "RIGHT" + ] + }, + "element": { + "description": "Information about the element used for a step.", + "properties": { + "context": { + "description": "Context of the element.", + "type": "string" + }, + "contextType": { + "description": "Type of the context that the element is in.", + "enum": [ + "native", + "web" + ], + "type": "string", + "x-enum-varnames": [ + "NATIVE", + "WEB" + ] + }, + "elementDescription": { + "description": "Description of the element.", + "type": "string" + }, + "multiLocator": { + "description": "Multi-locator to find the element.", + "type": "object" + }, + "relativePosition": { + "description": "Position of the action relative to the element.", + "properties": { + "x": { + "description": "The `relativePosition` on the `x` axis for the element.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `relativePosition` on the `y` axis for the element.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "textContent": { + "description": "Text content of the element.", + "type": "string" + }, + "userLocator": { + "description": "User locator to find the element.", + "properties": { + "failTestOnCannotLocate": { + "description": "Whether if the the test should fail if the element cannot be found.", + "type": "boolean" + }, + "values": { + "description": "Values of the user locator.", + "items": { + "description": "A single user locator object.", + "properties": { + "type": { + "description": "Type of a user locator.", + "enum": [ + "accessibility-id", + "id", + "ios-predicate-string", + "ios-class-chain", + "xpath" + ], + "type": "string", + "x-enum-varnames": [ + "ACCESSIBILITY_ID", + "ID", + "IOS_PREDICATE_STRING", + "IOS_CLASS_CHAIN", + "XPATH" + ] + }, + "value": { + "description": "Value of a user locator.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "viewName": { + "description": "Name of the view of the element.", + "type": "string" + } + }, + "type": "object" + }, + "enable": { + "description": "Boolean to change the state of the wifi for a `toggleWiFi` step type.", + "type": "boolean" + }, + "maxScrolls": { + "description": "Maximum number of scrolls to do for a `scrollToElement` step type.", + "format": "int64", + "type": "integer" + }, + "positions": { + "description": "List of positions for the `flick` step type. The maximum is 10 flicks per step", + "items": { + "description": "A description of a single position for a `flick` step type.", + "properties": { + "x": { + "description": "The `x` position for the flick.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `y` position for the flick.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "subtestPublicId": { + "description": "Public ID of the test to be played as part of a `playSubTest` step type.", + "type": "string" + }, + "value": { + "description": "Values used in the step. Used in multiple step types.", + "type": "string" + }, + "variable": { + "description": "Variable object for `extractVariable` step type.", + "properties": { + "example": { + "description": "An example for the variable.", + "example": "", + "type": "string" + }, + "name": { + "description": "The variable name.", + "example": "VAR_NAME", + "type": "string" + } + }, + "required": [ + "name", + "example" + ], + "type": "object" + }, + "withEnter": { + "description": "Boolean to indicate if `Enter` should be pressed at the end of the `typeText` step type.", + "type": "boolean" + }, + "x": { + "description": "Amount to scroll by on the `x` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "Amount to scroll by on the `y` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + } + }, "type": "object" }, "publicId": { @@ -1102953,6 +1105537,11 @@ ] } }, + "required": [ + "name", + "params", + "type" + ], "type": "object" }, "type": "array" @@ -1103005,20 +1105594,11 @@ "description": "Configuration object for a Synthetic mobile test.", "properties": { "initialApplicationArguments": { - "description": "Initial application arguments for a mobile test.", - "properties": { - "propertyNames": { - "description": "Name of the property.", - "properties": { - "pattern": { - "description": "The `propertyNames` `pattern`.", - "example": "^(?!_dd).*$", - "type": "string" - } - }, - "type": "object" - } + "additionalProperties": { + "description": "A single application argument.", + "type": "string" }, + "description": "Initial application arguments for a mobile test.", "type": "object" }, "variables": { @@ -1103076,7 +1105656,7 @@ "type": "object" }, "device_ids": { - "description": "The `SyntheticsMobileTest` `device_ids`.", + "description": "Array with the different device IDs used to run the test.", "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -1103105,7 +1105685,7 @@ "description": "Object describing the extra options for a Synthetic test.", "properties": { "allowApplicationCrash": { - "description": "The `SyntheticsMobileTestOptions` `allowApplicationCrash`.", + "description": "A boolean to set if an application crash would mark the test as failed.", "type": "boolean" }, "bindings": { @@ -1103113,32 +1105693,26 @@ "items": { "description": "Objects describing the binding used for a mobile test.", "properties": { - "items": { - "description": "Object describing the binding used for a mobile test.", - "properties": { - "principals": { - "description": "List of principals for a mobile test binding.", - "items": { - "description": "A principal for a mobile test binding.", - "maxLength": 1500, - "type": "string" - }, - "type": "array" - }, - "role": { - "description": "The definition of `SyntheticsMobileTestBindingItemsRole` object.", - "enum": [ - "editor", - "viewer" - ], - "type": "string", - "x-enum-varnames": [ - "EDITOR", - "VIEWER" - ] - } + "principals": { + "description": "List of principals for a mobile test binding.", + "items": { + "description": "A principal for a mobile test binding.", + "maxLength": 1500, + "type": "string" }, - "type": "object" + "type": "array" + }, + "relation": { + "description": "The type of relation for the binding.", + "enum": [ + "editor", + "viewer" + ], + "type": "string", + "x-enum-varnames": [ + "EDITOR", + "VIEWER" + ] } }, "type": "object" @@ -1103170,7 +1105744,7 @@ "type": "object" }, "defaultStepTimeout": { - "description": "The `SyntheticsMobileTestOptions` `defaultStepTimeout`.", + "description": "The default timeout for steps in the test (in seconds).", "format": "int32", "maximum": 300, "minimum": 1, @@ -1103178,6 +1105752,9 @@ }, "device_ids": { "description": "For mobile test, array with the different device IDs used to run the test.", + "example": [ + "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16" + ], "items": { "description": "The device ID.", "example": "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16", @@ -1103186,7 +1105763,7 @@ "type": "array" }, "disableAutoAcceptAlert": { - "description": "The `SyntheticsMobileTestOptions` `disableAutoAcceptAlert`.", + "description": "A boolean to disable auto accepting alerts.", "type": "boolean" }, "min_failure_duration": { @@ -1103201,11 +1105778,13 @@ "properties": { "applicationId": { "description": "Application ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaaa", "maxLength": 1500, "type": "string" }, "referenceId": { "description": "Reference ID of the mobile application.", + "example": "00000000-0000-0000-0000-aaaaaaaaaaab", "maxLength": 1500, "type": "string" }, @@ -1103215,6 +1105794,7 @@ "latest", "version" ], + "example": "latest", "type": "string", "x-enum-varnames": [ "LATEST", @@ -1103222,6 +1105802,11 @@ ] } }, + "required": [ + "applicationId", + "referenceId", + "referenceType" + ], "type": "object" }, "monitor_name": { @@ -1103229,14 +1105814,14 @@ "type": "string" }, "monitor_options": { - "description": "Object containing the options for a mobile Synthetic test as a monitor\n(for example, renotification).", + "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { "escalation_message": { "description": "Message to include in the escalation notification.", "type": "string" }, "notification_preset_name": { - "description": "The definition of `SyntheticsMobileTestOptionsMonitorOptionsNotificationPresetName` object.", + "description": "The name of the preset for the notification for the monitor.", "enum": [ "show_all", "hide_all", @@ -1103258,7 +1105843,7 @@ "type": "integer" }, "renotify_occurrences": { - "description": "The `SyntheticsMobileTestOptionsMonitorOptions` `renotify_occurrences`.", + "description": "The number of times to renotify if the test is still failing.", "format": "int64", "type": "integer" } @@ -1103273,7 +1105858,7 @@ "type": "integer" }, "noScreenshot": { - "description": "The `SyntheticsMobileTestOptions` `noScreenshot`.", + "description": "A boolean set to not take a screenshot for the step.", "type": "boolean" }, "restricted_roles": { @@ -1103343,6 +1105928,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1103353,23 +1105943,33 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { "description": "The frequency at which to run the Synthetic test (in seconds).", + "example": 300, "format": "int64", "maximum": 604800, "minimum": 300, "type": "integer" }, "verbosity": { - "description": "The `SyntheticsMobileTestOptions` `verbosity`.", + "description": "The level of verbosity for the mobile test.", "format": "int32", "maximum": 5, "minimum": 0, "type": "integer" } }, + "required": [ + "device_ids", + "tick_every", + "mobileApplication" + ], "type": "object" }, "public_id": { @@ -1103410,6 +1106010,7 @@ }, "name": { "description": "The name of the step.", + "example": "", "maxLength": 1500, "type": "string" }, @@ -1103418,7 +1106019,235 @@ "type": "boolean" }, "params": { - "description": "The parameters of the mobile step.", + "description": "The parameters of a mobile step.", + "properties": { + "check": { + "description": "Type of assertion to apply in an API test.", + "enum": [ + "equals", + "notEquals", + "contains", + "notContains", + "startsWith", + "notStartsWith", + "greater", + "lower", + "greaterEquals", + "lowerEquals", + "matchRegex", + "between", + "isEmpty", + "notIsEmpty" + ], + "type": "string", + "x-enum-varnames": [ + "EQUALS", + "NOT_EQUALS", + "CONTAINS", + "NOT_CONTAINS", + "STARTS_WITH", + "NOT_STARTS_WITH", + "GREATER", + "LOWER", + "GREATER_EQUALS", + "LOWER_EQUALS", + "MATCH_REGEX", + "BETWEEN", + "IS_EMPTY", + "NOT_IS_EMPTY" + ] + }, + "delay": { + "description": "Number of milliseconds to wait between inputs in a `typeText` step type.", + "format": "int64", + "maximum": 5000, + "minimum": 0, + "type": "integer" + }, + "direction": { + "description": "The direction of the scroll for a `scrollToElement` step type.", + "enum": [ + "up", + "down", + "left", + "right" + ], + "type": "string", + "x-enum-varnames": [ + "UP", + "DOWN", + "LEFT", + "RIGHT" + ] + }, + "element": { + "description": "Information about the element used for a step.", + "properties": { + "context": { + "description": "Context of the element.", + "type": "string" + }, + "contextType": { + "description": "Type of the context that the element is in.", + "enum": [ + "native", + "web" + ], + "type": "string", + "x-enum-varnames": [ + "NATIVE", + "WEB" + ] + }, + "elementDescription": { + "description": "Description of the element.", + "type": "string" + }, + "multiLocator": { + "description": "Multi-locator to find the element.", + "type": "object" + }, + "relativePosition": { + "description": "Position of the action relative to the element.", + "properties": { + "x": { + "description": "The `relativePosition` on the `x` axis for the element.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `relativePosition` on the `y` axis for the element.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "textContent": { + "description": "Text content of the element.", + "type": "string" + }, + "userLocator": { + "description": "User locator to find the element.", + "properties": { + "failTestOnCannotLocate": { + "description": "Whether if the the test should fail if the element cannot be found.", + "type": "boolean" + }, + "values": { + "description": "Values of the user locator.", + "items": { + "description": "A single user locator object.", + "properties": { + "type": { + "description": "Type of a user locator.", + "enum": [ + "accessibility-id", + "id", + "ios-predicate-string", + "ios-class-chain", + "xpath" + ], + "type": "string", + "x-enum-varnames": [ + "ACCESSIBILITY_ID", + "ID", + "IOS_PREDICATE_STRING", + "IOS_CLASS_CHAIN", + "XPATH" + ] + }, + "value": { + "description": "Value of a user locator.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "viewName": { + "description": "Name of the view of the element.", + "type": "string" + } + }, + "type": "object" + }, + "enable": { + "description": "Boolean to change the state of the wifi for a `toggleWiFi` step type.", + "type": "boolean" + }, + "maxScrolls": { + "description": "Maximum number of scrolls to do for a `scrollToElement` step type.", + "format": "int64", + "type": "integer" + }, + "positions": { + "description": "List of positions for the `flick` step type. The maximum is 10 flicks per step", + "items": { + "description": "A description of a single position for a `flick` step type.", + "properties": { + "x": { + "description": "The `x` position for the flick.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "The `y` position for the flick.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "subtestPublicId": { + "description": "Public ID of the test to be played as part of a `playSubTest` step type.", + "type": "string" + }, + "value": { + "description": "Values used in the step. Used in multiple step types.", + "type": "string" + }, + "variable": { + "description": "Variable object for `extractVariable` step type.", + "properties": { + "example": { + "description": "An example for the variable.", + "example": "", + "type": "string" + }, + "name": { + "description": "The variable name.", + "example": "VAR_NAME", + "type": "string" + } + }, + "required": [ + "name", + "example" + ], + "type": "object" + }, + "withEnter": { + "description": "Boolean to indicate if `Enter` should be pressed at the end of the `typeText` step type.", + "type": "boolean" + }, + "x": { + "description": "Amount to scroll by on the `x` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + }, + "y": { + "description": "Amount to scroll by on the `y` axis for a `scroll` step type.", + "format": "int64", + "type": "integer" + } + }, "type": "object" }, "publicId": { @@ -1103475,6 +1106304,11 @@ ] } }, + "required": [ + "name", + "params", + "type" + ], "type": "object" }, "type": "array" @@ -1106137,6 +1108971,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1106237,11 +1109074,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1106355,6 +1109217,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1106365,6 +1109232,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1107989,6 +1110860,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1108089,11 +1110963,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1108207,6 +1111106,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1108217,6 +1111121,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1109805,6 +1112713,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1109905,11 +1112816,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1110023,6 +1112959,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1110033,6 +1112974,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": { @@ -1111468,6 +1114413,9 @@ ] } }, + "required": [ + "executionRule" + ], "type": "object" }, "device_ids": { @@ -1111568,11 +1114516,36 @@ "monitor_options": { "description": "Object containing the options for a Synthetic test as a monitor\n(for example, renotification).", "properties": { + "escalation_message": { + "description": "Message to include in the escalation notification.", + "type": "string" + }, + "notification_preset_name": { + "description": "The name of the preset for the notification for the monitor.", + "enum": [ + "show_all", + "hide_all", + "hide_query", + "hide_handles" + ], + "type": "string", + "x-enum-varnames": [ + "SHOW_ALL", + "HIDE_ALL", + "HIDE_QUERY", + "HIDE_HANDLES" + ] + }, "renotify_interval": { "description": "Time interval before renotifying if the test is still failing\n(in minutes).", "format": "int64", "minimum": 0, "type": "integer" + }, + "renotify_occurrences": { + "description": "The number of times to renotify if the test is still failing.", + "format": "int64", + "type": "integer" } }, "type": "object" @@ -1111686,6 +1114659,11 @@ "type": "string" } }, + "required": [ + "day", + "from", + "to" + ], "type": "object" }, "type": "array" @@ -1111696,6 +1114674,10 @@ "type": "string" } }, + "required": [ + "timeframes", + "timezone" + ], "type": "object" }, "tick_every": {