Datadog Synthetics
Get test
このページは日本語には対応しておりません。随時翻訳に取り組んでいます。翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。
Get the detailed configuration associated with a Synthetics test.
Inputs
The ID of the test to get details from.
Outputs
Expand All
Notification message associated with the test.
Array of tags attached to the test.
A map of tags where both the keys and the values are strings. If a key has multiple values, the last value wins.
A map of tags where the keys are strings and the values are lists of strings.
Array of locations used to run the test.
Type of the Synthetic test, either api or browser.
Allowed enum values: api,browser
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
Configuration object for a Synthetic test.
Object describing the Synthetic test request.
URL to perform the test with.
Body to include in the test.
Timeout in seconds for the test.
Host name to perform the test with.
Port to use when performing the test.
Query to use for the test.
DNS server to use for DNS tests.
Object to handle basic authentication when performing the test.
Headers to include when performing the test.
Client certificate to use when performing the test request.
Define a request certificate.
Content of the certificate or key.
File name for the certificate or key.
Date of update of the certificate or key, ISO format.
Define a request certificate.
Content of the certificate or key.
File name for the certificate or key.
Date of update of the certificate or key, ISO format.
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.
Determines whether or not to save the response body.
DNS server port to use for DNS tests.
Number of pings to use per test.
Turns on a traceroute probe to discover all gateways along the path to the host destination.
Allows loading insecure content for an HTTP request in a multistep test step.
Specifies whether or not the request follows redirects.
Message to send for UDP or WebSocket tests.
gRPC service on which you want to perform the healthcheck.
Metadata to include when performing the gRPC test.
The proxy to perform the test.
URL of the proxy to perform the test.
Headers to include when performing the test.
Browser tests only - array of variables used for the test steps.
Type of browser test variable.
Allowed enum values: element,email,global,javascript,text
Example for the variable.
Array of variables used for the test.
Type of the configuration variable.
Allowed enum values: global,text
Example for the variable.
ID of the variable for global variables.
Array of assertions used for the test.
default:
Define whether you want to start (live) or pause (paused) a Synthetic test.
Allowed enum values: live,paused
For browser test, the steps of the test.
A boolean set to allow this step to fail.
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
The parameters of the step.
The time before declaring a step failed.
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
Object describing the extra options for a Synthetic test.
Minimum number of locations in failure required to trigger an alert.
Minimum amount of time in failure required to trigger an alert.
Object describing the retry strategy to apply to a Synthetic test.
Number of times a test needs to be retried before marking a location as failed.
Time interval between retries (in milliseconds).
The frequency at which to run the Synthetic test (in seconds).
The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
Object containing the options for a Synthetic test as a monitor (for example, renotification).
Time interval before renotifying if the test is still failing (in minutes).
Integer from 1 (high) to 5 (low) indicating alert severity.
A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
Allows loading insecure content for an HTTP request.
For API HTTP test, whether or not the test should follow redirects.
For SSL test, whether or not the test should allow self signed certificates.
checkCertificateRevocation
For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
For browser test, array with the different device IDs used to run the test.
Prevents saving screenshots of the steps.
Whether or not to disable CORS mechanism.
The RUM data collection settings for the Synthetic browser test.
Determines whether RUM data is collected during test runs.
RUM application ID used to collect RUM data for the browser test.
RUM application API key ID used to collect RUM data for the browser test.
The associated monitor ID.
