Datadog Synthetics

List tests

このページは日本語には対応しておりません。随時翻訳に取り組んでいます。翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。

Get the list of all Synthetic tests.

Inputs

フィールド

種類

説明

limit

number

The number of tests to return. Defaults to 50. Max 200.

default: 50

Outputs

Expand All

フィールド

種類

説明

tests

[object]

Array of Synthetic tests configuration.

name

string

Name of the test.

message

string

Notification message associated with the test.

tags

[string]

Array of tags attached to the test.

tag_value

object

A map of tags where both the keys and the values are strings. If a key has multiple values, the last value wins.

tag_value_list

object

A map of tags where the keys are strings and the values are lists of strings.

locations

[string]

Array of locations used to run the test.

type

enum

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

creator

object

name

string

handle

string

email

string

subtype

enum

The subtype of the Synthetic API test, http, ssl, tcp, dns, icmp, udp, websocket, grpc or multi. Allowed enum values: http,ssl,tcp,dns,multi,icmp,udp,websocket,grpc

public_id

string

The test ID.

config

object

Configuration object for a Synthetic test.

request

object

Object describing the Synthetic test request.

method

enum

url

string

URL to perform the test with.

body

string

Body to include in the test.

timeout

number

Timeout in seconds for the test.

host

string

Host name to perform the test with.

port

number

Port to use when performing the test.

query

object

Query to use for the test.

dnsServer

string

DNS server to use for DNS tests.

basicAuth

Object to handle basic authentication when performing the test.

headers

object

Headers to include when performing the test.

certificate

object

Client certificate to use when performing the test request.

cert

object

Define a request certificate.

content

string

Content of the certificate or key.

filename

string

File name for the certificate or key.

updatedAt

string

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

key

object

Define a request certificate.

content

string

Content of the certificate or key.

filename

string

File name for the certificate or key.

updatedAt

string

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

servername

string

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

noSavingResponseBody

boolean

Determines whether or not to save the response body.

dnsServerPort

number

DNS server port to use for DNS tests.

numberOfPackets

number

Number of pings to use per test.

shouldTrackHops

boolean

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

allow_insecure

boolean

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

follow_redirects

boolean

Specifies whether or not the request follows redirects.

message

string

Message to send for UDP or WebSocket tests.

service

string

gRPC service on which you want to perform the healthcheck.

metadata

object

Metadata to include when performing the gRPC test.

proxy

object

The proxy to perform the test.

url [required]

string

URL of the proxy to perform the test.

headers

object

Headers to include when performing the test.

variables

[object]

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

type [required]

enum

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

name [required]

string

Name of the variable.

pattern

string

Pattern of the variable.

example

string

Example for the variable.

id

string

ID for the variable.

configVariables

[object]

Array of variables used for the test.

type [required]

enum

Type of the configuration variable. Allowed enum values: global,text

name [required]

string

Name of the variable.

pattern

string

Pattern of the variable.

example

string

Example for the variable.

id

string

ID of the variable for global variables.

assertions

[]

Array of assertions used for the test.

default:

status

enum

Define whether you want to start (live) or pause (paused) a Synthetic test. Allowed enum values: live,paused

steps

[object]

For browser test, the steps of the test.

allowFailure

boolean

A boolean set to allow this step to fail.

isCritical

boolean

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

name

string

The name of the step.

params

object

The parameters of the step.

timeout

number

The time before declaring a step failed.

type

enum

Step type used in your Synthetic test. Allowed 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

options

object

Object describing the extra options for a Synthetic test.

min_location_failed

number

Minimum number of locations in failure required to trigger an alert.

min_failure_duration

number

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

retry

object

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

count

number

Number of times a test needs to be retried before marking a location as failed.

interval

number

Time interval between retries (in milliseconds).

tick_every

number

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

monitor_name

string

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

monitor_options

object

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

renotify_interval

number

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

monitor_priority

number

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

restricted_roles

string

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

allow_insecure

boolean

Allows loading insecure content for an HTTP request.

follow_redirects

boolean

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

accept_self_signed

boolean

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

checkCertificateRevocation

boolean

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

device_ids

[string]

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

noScreenshot

boolean

Prevents saving screenshots of the steps.

disableCors

boolean

Whether or not to disable CORS mechanism.

rumSettings

object

The RUM data collection settings for the Synthetic browser test.

isEnabled [required]

boolean

Determines whether RUM data is collected during test runs.

applicationId

string

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

clientTokenId

number

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

monitor_id

number

The associated monitor ID.