Create a browser test
POST
https://api.datadoghq.com/api/v1/synthetics/tests/browserhttps://api.us3.datadoghq.com/api/v1/synthetics/tests/browserhttps://api.us5.datadoghq.com/api/v1/synthetics/tests/browserhttps://api.datadoghq.eu/api/v1/synthetics/tests/browserhttps://api.ap1.datadoghq.com/api/v1/synthetics/tests/browserhttps://api.ap2.datadoghq.com/api/v1/synthetics/tests/browserhttps://api.uk1.datadoghq.com/api/v1/synthetics/tests/browserhttps://api.ddog-gov.com/api/v1/synthetics/tests/browserhttps://api.us2.ddog-gov.com/api/v1/synthetics/tests/browserOverview
Create a Synthetic browser test.
OAuth apps require the synthetics_write authorization scope to access this endpoint.
Request
Body Data (required)
Details of the test to create.
Field
Type
Description
config [required]object
Configuration object for a Synthetic browser test.
assertions [required][<oneOf>]
Array of assertions used for the test.
Object 1object
An assertion which uses a simple target.
operator [required]enum
Assertion operator to apply.
Allowed enum values:
contains, doesNotContain, is, isNot, lessThan, lessThanOrEqual, moreThan, moreThanOrEqual, matches, doesNotMatchShow 5 more
validates, isInMoreThan, isInLessThan, doesNotExist, isUndefinedpropertystring
The associated assertion property.
target [required]<oneOf>
Value used by the operator.
Object 1double
Numeric value used by the operator in assertions.
Object 2string
String value used by the operator in assertions. Supports templated variables.
timingsScopeenum
Timings scope for response time assertions.
Allowed enum values:
all, withoutDNStype [required]enum
Type of the assertion.
Allowed enum values:
body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersionShow 13 more
latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection, multiNetworkHop, jitter, mcpToolNameLength, mcpToolCountObject 2object
An assertion which targets body hash.
operator [required]enum
Assertion operator to apply.
Allowed enum values:
md5, sha1, sha256target [required]<oneOf>
Value used by the operator.
Object 1double
Numeric value used by the operator in assertions.
Object 2string
String value used by the operator in assertions. Supports templated variables.
type [required]enum
Type of the assertion.
Allowed enum values:
bodyHashObject 3object
An assertion for the validatesJSONPath operator.
operator [required]enum
Assertion operator to apply.
Allowed enum values:
validatesJSONPathpropertystring
The associated assertion property.
targetobject
Composed target for validatesJSONPath operator.
elementsOperatorstring
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.
jsonPathstring
The JSON path to assert.
operatorstring
The specific operator to use on the path.
targetValue<oneOf>
The path target value to compare to.
Object 1double
Numeric value used by the operator in assertions.
Object 2string
String value used by the operator in assertions. Supports templated variables.
type [required]enum
Type of the assertion.
Allowed enum values:
body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersionShow 13 more
latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection, multiNetworkHop, jitter, mcpToolNameLength, mcpToolCountObject 4object
An assertion for the validatesJSONSchema operator.
operator [required]enum
Assertion operator to apply.
Allowed enum values:
validatesJSONSchematargetobject
Composed target for validatesJSONSchema operator.
jsonSchemastring
The JSON Schema to assert.
metaSchemaenum
The JSON Schema meta-schema version used in the assertion.
Allowed enum values:
draft-07, draft-06type [required]enum
Type of the assertion.
Allowed enum values:
body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersionShow 13 more
latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection, multiNetworkHop, jitter, mcpToolNameLength, mcpToolCountObject 5object
An assertion for the validatesXPath operator.
operator [required]enum
Assertion operator to apply.
Allowed enum values:
validatesXPathpropertystring
The associated assertion property.
targetobject
Composed target for validatesXPath operator.
operatorstring
The specific operator to use on the path.
targetValue<oneOf>
The path target value to compare to.
Object 1double
Numeric value used by the operator in assertions.
Object 2string
String value used by the operator in assertions. Supports templated variables.
xPathstring
The X path to assert.
type [required]enum
Type of the assertion.
Allowed enum values:
body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersionShow 13 more
latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection, multiNetworkHop, jitter, mcpToolNameLength, mcpToolCountObject 6object
A JavaScript assertion.
code [required]string
The JavaScript code that performs the assertions.
type [required]enum
Type of the assertion.
Allowed enum values:
javascriptObject 7object
An assertion that checks that an MCP server advertises the expected capabilities.
operator [required]enum
Assertion operator to apply.
Allowed enum values:
contains, doesNotContain, is, isNot, lessThan, lessThanOrEqual, moreThan, moreThanOrEqual, matches, doesNotMatchShow 5 more
validates, isInMoreThan, isInLessThan, doesNotExist, isUndefinedtarget [required][string]
List of MCP server capabilities to assert against.
type [required]enum
Type of the assertion.
Allowed enum values:
mcpServerCapabilitiesObject 8object
An assertion that verifies the MCP server response respects the MCP specification.
type [required]enum
Type of the assertion.
Allowed enum values:
mcpRespectsSpecificationconfigVariables[object]
Array of variables used for the test.
examplestring
Example for the variable.
idstring
ID of the variable for global variables.
name [required]string
Name of the variable.
patternstring
Pattern of the variable.
secureboolean
Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.
type [required]enum
Type of the configuration variable.
Allowed enum values:
global, text, emailrequest [required]object
Object describing the Synthetic test request.
allow_insecureboolean
Allows loading insecure content for an HTTP request in a multistep test step.
basicAuth<oneOf>
Object to handle basic authentication when performing the test.
<type=web>object
Object to handle basic authentication when performing the test.
passwordstring
Password to use for the basic authentication.
typeenum
The type of basic authentication to use when performing the test.
webAllowed enum values:
webusernamestring
Username to use for the basic authentication.
<type=sigv4>object
Object to handle SIGV4 authentication when performing the test.
accessKey [required]string
Access key for the SIGV4 authentication.
regionstring
Region for the SIGV4 authentication.
secretKey [required]string
Secret key for the SIGV4 authentication.
serviceNamestring
Service name for the SIGV4 authentication.
sessionTokenstring
Session token for the SIGV4 authentication.
type [required]enum
The type of authentication to use when performing the test.
sigv4Allowed enum values:
sigv4<type=ntlm>object
Object to handle NTLM authentication when performing the test.
domainstring
Domain for the authentication to use when performing the test.
passwordstring
Password for the authentication to use when performing the test.
type [required]enum
The type of authentication to use when performing the test.
ntlmAllowed enum values:
ntlmusernamestring
Username for the authentication to use when performing the test.
workstationstring
Workstation for the authentication to use when performing the test.
<type=digest>object
Object to handle digest authentication when performing the test.
password [required]string
Password to use for the digest authentication.
type [required]enum
The type of basic authentication to use when performing the test.
digestAllowed enum values:
digestusername [required]string
Username to use for the digest authentication.
<type=oauth-client>object
Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]string
Access token URL to use when performing the authentication.
audiencestring
Audience to use when performing the authentication.
clientId [required]string
Client ID to use when performing the authentication.
clientSecret [required]string
Client secret to use when performing the authentication.
resourcestring
Resource to use when performing the authentication.
scopestring
Scope to use when performing the authentication.
tokenApiAuthentication [required]enum
Type of token to use when performing the authentication.
Allowed enum values:
header, bodytype [required]enum
The type of basic authentication to use when performing the test.
oauth-clientAllowed enum values:
oauth-client<type=oauth-rop>object
Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]string
Access token URL to use when performing the authentication.
audiencestring
Audience to use when performing the authentication.
clientIdstring
Client ID to use when performing the authentication.
clientSecretstring
Client secret to use when performing the authentication.
password [required]string
Password to use when performing the authentication.
resourcestring
Resource to use when performing the authentication.
scopestring
Scope to use when performing the authentication.
tokenApiAuthentication [required]enum
Type of token to use when performing the authentication.
Allowed enum values:
header, bodytype [required]enum
The type of basic authentication to use when performing the test.
oauth-ropAllowed enum values:
oauth-ropusername [required]string
Username to use when performing the authentication.
<type=jwt>object
Object to handle JWT authentication when performing the test.
addClaimsobject
Standard JWT claims to automatically inject.
expboolean
Whether to inject the exp (expiration) claim.
iatboolean
Whether to inject the iat (issued at) claim.
algorithm [required]enum
Algorithm to use for the JWT authentication.
Allowed enum values:
HS256, RS256, ES256expiresInint64
Token time-to-live in seconds.
headerstring
Custom JWT header as a JSON string.
payload [required]string
JWT claims as a JSON string.
secret [required]string
Signing key for the JWT authentication. Use the shared secret for HS256
or the private key (PEM format) for RS256 and ES256.
tokenPrefixstring
Prefix added before the token in the Authorization header. Defaults to Bearer.
type [required]enum
The type of authentication to use when performing the test.
jwtAllowed enum values:
jwtbodystring
Body to include in the test.
bodyTypeenum
Type of the request body.
Allowed enum values:
text/plain, application/json, text/xml, text/html, application/x-www-form-urlencoded, graphql, application/octet-stream, multipart/form-datacallTypeenum
The type of call to perform. Used by gRPC steps (healthcheck, unary)
and MCP steps (init, tool_list, tool_call). Valid values depend on
the parent step's subtype.
Allowed enum values:
healthcheck, unary, init, tool_list, tool_callcertificateobject
Client certificate to use when performing the test request.
certobject
Define a request certificate.
contentstring
Content of the certificate or key.
filenamestring
File name for the certificate or key.
updatedAtstring
Date of update of the certificate or key, ISO format.
keyobject
Define a request certificate.
contentstring
Content of the certificate or key.
filenamestring
File name for the certificate or key.
updatedAtstring
Date of update of the certificate or key, ISO format.
certificateDomains[string]
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.
checkCertificateRevocationboolean
Check for certificate revocation.
compressedJsonDescriptorstring
A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFilestring
A protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetchingboolean
Disable fetching intermediate certificates from AIA.
dnsServerstring
DNS server to use for DNS tests.
dnsServerPort<oneOf>
DNS server port to use for DNS tests.
Object 1int64
Integer DNS server port number to use when performing the test.
Object 2string
String DNS server port number to use when performing the test. Supports templated variables.
files[object]
Files to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKeystring
Bucket key of the file.
contentstring
Content of the file.
encodingstring
Encoding of the file content. The only supported value is base64, indicating the content field contains base64-encoded data.
namestring
Name of the file.
originalFileNamestring
Original name of the file.
sizeint64
Size of the file.
typestring
Type of the file.
follow_redirectsboolean
Specifies whether or not the request follows redirects.
formobject
Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>string
A single form entry.
headersobject
Headers to include when performing the test.
<any-key>string
A single Header.
hoststring
Host name to perform the test with.
httpVersionenum
HTTP version to use for a Synthetic test.
Allowed enum values:
http1, http2, anyignore_certificate_validationboolean
For SSL tests, whether the test should ignore certificate validation.
isMessageBase64Encodedboolean
Whether the message is base64 encoded.
mcpProtocolVersionenum
The MCP protocol version used by the step. See https://modelcontextprotocol.io/specification.
Allowed enum values:
2025-06-18messagestring
Message to send for UDP or WebSocket tests.
metadataobject
Metadata to include when performing the gRPC test.
<any-key>string
A single metadatum.
methodstring
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.
noSavingResponseBodyboolean
Determines whether or not to save the response body.
numberOfPacketsint32
Number of pings to use per test.
persistCookiesboolean
Persist cookies across redirects.
port<oneOf>
Port to use when performing the test.
Object 1int64
Integer Port number to use when performing the test.
Object 2string
String Port number to use when performing the test. Supports templated variables.
proxyobject
The proxy to perform the test.
headersobject
Headers to include when performing the test.
<any-key>string
A single Header.
url [required]string
URL of the proxy to perform the test.
queryobject
Query to use for the test.
servernamestring
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.
servicestring
The gRPC service on which you want to perform the gRPC call.
shouldTrackHopsboolean
Turns on a traceroute probe to discover all gateways along the path to the host destination.
timeoutdouble
Timeout in seconds for the test.
toolArgsobject
Arguments to pass to the MCP tool. Free-form object whose shape depends on the tool. Used when callType is tool_call.
toolNamestring
The name of the MCP tool to call. Required when callType is tool_call.
urlstring
URL to perform the test with.
variables[object]
Array of variables used for the test steps.
examplestring
Example for the variable.
idstring
ID for the variable. Global variables require an ID.
name [required]string
Name of the variable.
patternstring
Pattern of the variable.
secureboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]enum
Type of browser test variable.
Allowed enum values:
element, email, global, textlocations [required][string]
Array of locations used to run the test.
message [required]string
Notification message associated with the test. Message can either be text or an empty string.
name [required]string
Name of the test.
options [required]object
Object describing the extra options for a Synthetic test.
accept_self_signedboolean
For SSL tests, whether or not the test should allow self signed certificates.
allow_insecureboolean
Allows loading insecure content for an HTTP request in an API test.
bits_ai_auto_investigateboolean
Whether Bits AI automatically investigates alerts from the test monitor.
blockedRequestPatterns[string]
Array of URL patterns to block.
captureNetworkPayloadsboolean
Capture HTTP request/response headers and bodies for Fetch/XHR calls made during browser tests.
checkCertificateRevocationboolean
For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP.
ciobject
CI/CD options for a Synthetic test.
executionRule [required]enum
Execution rule for a Synthetic test.
Allowed enum values:
blocking, non_blocking, skippeddevice_ids[string]
For browser test, array with the different device IDs used to run the test.
disableAiaIntermediateFetchingboolean
For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA.
disableCorsboolean
Whether or not to disable CORS mechanism.
disableCspboolean
Disable Content Security Policy for browser tests.
enableProfilingboolean
Enable profiling for browser tests.
enableSecurityTestingboolean
DEPRECATED Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.
follow_redirectsboolean
For API HTTP test, whether or not the test should follow redirects.
httpVersionenum
HTTP version to use for a Synthetic test.
Allowed enum values:
http1, http2, anyignoreServerCertificateErrorboolean
Ignore server certificate error for browser tests.
ignore_certificate_validationboolean
For SSL tests, whether the test should ignore certificate validation.
initialNavigationTimeoutint64
Timeout before declaring the initial step as failed (in seconds) for browser tests.
min_failure_durationint64
Minimum amount of time in failure required to trigger an alert.
min_location_failedint64
Minimum number of locations in failure required to trigger an alert.
monitor_namestring
The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
monitor_optionsobject
Object containing the options for a Synthetic test as a monitor (for example, renotification).
escalation_messagestring
Message to include in the escalation notification.
notification_preset_nameenum
The name of the preset for the notification for the monitor.
Allowed enum values:
show_all, hide_all, hide_query, hide_handles, hide_query_and_handles, show_only_snapshot, hide_handles_and_footerrenotify_intervalint64
Time interval before renotifying if the test is still failing (in minutes).
renotify_occurrencesint64
The number of times to renotify if the test is still failing.
monitor_priorityint32
Integer from 1 (high) to 5 (low) indicating alert severity.
noScreenshotboolean
Prevents saving screenshots of the steps.
restricted_roles[string]
DEPRECATED A list of role identifiers that can be pulled from the Roles API, for restricting read and write access. This field is deprecated. Use the restriction policies API to manage permissions.
retryobject
Object describing the retry strategy to apply to a Synthetic test.
countint64
Number of times a test needs to be retried before marking a location as failed. Defaults to 0.
intervaldouble
Time interval between retries (in milliseconds). Defaults to 300ms.
rumSettingsobject
The RUM data collection settings for the Synthetic browser test. Note: There are 3 ways to format RUM settings:
{ isEnabled: false }
RUM data is not collected.
{ isEnabled: true }
RUM data is collected from the Synthetic test's default application.
{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }
RUM data is collected using the specified application.
applicationIdstring
RUM application ID used to collect RUM data for the browser test.
clientTokenIdint64
RUM application API key ID used to collect RUM data for the browser test.
isEnabled [required]boolean
Determines whether RUM data is collected during test runs.
schedulingobject
Object containing timeframes and timezone used for advanced scheduling.
timeframes [required][object]
Array containing objects describing the scheduling pattern to apply to each day.
day [required]int32
Number representing the day of the week.
from [required]string
The hour of the day on which scheduling starts.
to [required]string
The hour of the day on which scheduling ends.
timezone [required]string
Timezone in which the timeframe is based.
tick_everyint64
The frequency at which to run the Synthetic test (in seconds).
statusenum
Define whether you want to start (live) or pause (paused) a
Synthetic test.
Allowed enum values:
live, pausedsteps[object]
Array of steps for the test.
allowFailureboolean
A boolean set to allow this step to fail.
alwaysExecuteboolean
A boolean set to always execute this step even if the previous step failed or was skipped.
exitIfSucceedboolean
A boolean set to exit the test if the step succeeds.
isCriticalboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
namestring
The name of the step.
noScreenshotboolean
A boolean set to skip taking a screenshot for the step.
paramsobject
The parameters of the step.
public_idstring
The public ID of the step.
timeoutint64
The time before declaring a step failed.
typeenum
Step type used in your Synthetic test.
Allowed enum values:
assertCurrentUrl, assertElementAttribute, assertElementContent, assertElementPresent, assertEmail, assertFileDownload, assertFromJavascript, assertPageContains, assertPageLacks, assertRequestsShow 19 more
click, drag, drop, extractFromJavascript, extractFromEmailBody, extractVariable, goToEmailLink, goToUrl, goToUrlAndMeasureTti, hover, playSubTest, pressKey, refresh, runApiTest, scroll, selectOption, typeText, uploadFiles, waittags[string]
Array of tags attached to the test.
type [required]enum
Type of the Synthetic test, browser.
browserAllowed enum values:
browserCreate a browser test returns "OK - Returns saved rumSettings." response
{
"config": {
"assertions": [],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com",
"certificateDomains": [
"https://datadoghq.com"
]
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"tablet"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"rumSettings": {
"isEnabled": true,
"applicationId": "mockApplicationId",
"clientTokenId": 12345
},
"tick_every": 300,
"ci": {
"executionRule": "skipped"
},
"ignoreServerCertificateError": true,
"disableCsp": true,
"initialNavigationTimeout": 200
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}Create a browser test returns "OK - Returns the created test details." response
{
"config": {
"assertions": [],
"variables": [
{
"type": "text",
"name": "TEST_VARIABLE",
"pattern": "secret",
"secure": true,
"example": "secret"
}
],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text",
"secure": true
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com"
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"chrome.laptop_large"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"tick_every": 300,
"enableProfiling": true,
"enableSecurityTesting": true
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"alwaysExecute": true,
"exitIfSucceed": true,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}Create a browser test with advanced scheduling options returns "OK - Returns the created test details." response
{
"config": {
"assertions": [],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com"
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"tablet"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"tick_every": 300,
"scheduling": {
"timeframes": [
{
"day": 1,
"from": "07:00",
"to": "16:00"
},
{
"day": 3,
"from": "07:00",
"to": "16:00"
}
],
"timezone": "America/New_York"
}
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}Response
OK - Returns the created test details.
Object containing details about a Synthetic browser test.
Field
Type
Description
config [required]object
Configuration object for a Synthetic browser test.
assertions [required][<oneOf>]
Array of assertions used for the test.
Object 1object
An assertion which uses a simple target.
operator [required]enum
Assertion operator to apply.
Allowed enum values:
contains, doesNotContain, is, isNot, lessThan, lessThanOrEqual, moreThan, moreThanOrEqual, matches, doesNotMatchShow 5 more
validates, isInMoreThan, isInLessThan, doesNotExist, isUndefinedpropertystring
The associated assertion property.
target [required]<oneOf>
Value used by the operator.
Object 1double
Numeric value used by the operator in assertions.
Object 2string
String value used by the operator in assertions. Supports templated variables.
timingsScopeenum
Timings scope for response time assertions.
Allowed enum values:
all, withoutDNStype [required]enum
Type of the assertion.
Allowed enum values:
body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersionShow 13 more
latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection, multiNetworkHop, jitter, mcpToolNameLength, mcpToolCountObject 2object
An assertion which targets body hash.
operator [required]enum
Assertion operator to apply.
Allowed enum values:
md5, sha1, sha256target [required]<oneOf>
Value used by the operator.
Object 1double
Numeric value used by the operator in assertions.
Object 2string
String value used by the operator in assertions. Supports templated variables.
type [required]enum
Type of the assertion.
Allowed enum values:
bodyHashObject 3object
An assertion for the validatesJSONPath operator.
operator [required]enum
Assertion operator to apply.
Allowed enum values:
validatesJSONPathpropertystring
The associated assertion property.
targetobject
Composed target for validatesJSONPath operator.
elementsOperatorstring
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.
jsonPathstring
The JSON path to assert.
operatorstring
The specific operator to use on the path.
targetValue<oneOf>
The path target value to compare to.
Object 1double
Numeric value used by the operator in assertions.
Object 2string
String value used by the operator in assertions. Supports templated variables.
type [required]enum
Type of the assertion.
Allowed enum values:
body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersionShow 13 more
latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection, multiNetworkHop, jitter, mcpToolNameLength, mcpToolCountObject 4object
An assertion for the validatesJSONSchema operator.
operator [required]enum
Assertion operator to apply.
Allowed enum values:
validatesJSONSchematargetobject
Composed target for validatesJSONSchema operator.
jsonSchemastring
The JSON Schema to assert.
metaSchemaenum
The JSON Schema meta-schema version used in the assertion.
Allowed enum values:
draft-07, draft-06type [required]enum
Type of the assertion.
Allowed enum values:
body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersionShow 13 more
latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection, multiNetworkHop, jitter, mcpToolNameLength, mcpToolCountObject 5object
An assertion for the validatesXPath operator.
operator [required]enum
Assertion operator to apply.
Allowed enum values:
validatesXPathpropertystring
The associated assertion property.
targetobject
Composed target for validatesXPath operator.
operatorstring
The specific operator to use on the path.
targetValue<oneOf>
The path target value to compare to.
Object 1double
Numeric value used by the operator in assertions.
Object 2string
String value used by the operator in assertions. Supports templated variables.
xPathstring
The X path to assert.
type [required]enum
Type of the assertion.
Allowed enum values:
body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersionShow 13 more
latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection, multiNetworkHop, jitter, mcpToolNameLength, mcpToolCountObject 6object
A JavaScript assertion.
code [required]string
The JavaScript code that performs the assertions.
type [required]enum
Type of the assertion.
Allowed enum values:
javascriptObject 7object
An assertion that checks that an MCP server advertises the expected capabilities.
operator [required]enum
Assertion operator to apply.
Allowed enum values:
contains, doesNotContain, is, isNot, lessThan, lessThanOrEqual, moreThan, moreThanOrEqual, matches, doesNotMatchShow 5 more
validates, isInMoreThan, isInLessThan, doesNotExist, isUndefinedtarget [required][string]
List of MCP server capabilities to assert against.
type [required]enum
Type of the assertion.
Allowed enum values:
mcpServerCapabilitiesObject 8object
An assertion that verifies the MCP server response respects the MCP specification.
type [required]enum
Type of the assertion.
Allowed enum values:
mcpRespectsSpecificationconfigVariables[object]
Array of variables used for the test.
examplestring
Example for the variable.
idstring
ID of the variable for global variables.
name [required]string
Name of the variable.
patternstring
Pattern of the variable.
secureboolean
Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.
type [required]enum
Type of the configuration variable.
Allowed enum values:
global, text, emailrequest [required]object
Object describing the Synthetic test request.
allow_insecureboolean
Allows loading insecure content for an HTTP request in a multistep test step.
basicAuth<oneOf>
Object to handle basic authentication when performing the test.
<type=web>object
Object to handle basic authentication when performing the test.
passwordstring
Password to use for the basic authentication.
typeenum
The type of basic authentication to use when performing the test.
webAllowed enum values:
webusernamestring
Username to use for the basic authentication.
<type=sigv4>object
Object to handle SIGV4 authentication when performing the test.
accessKey [required]string
Access key for the SIGV4 authentication.
regionstring
Region for the SIGV4 authentication.
secretKey [required]string
Secret key for the SIGV4 authentication.
serviceNamestring
Service name for the SIGV4 authentication.
sessionTokenstring
Session token for the SIGV4 authentication.
type [required]enum
The type of authentication to use when performing the test.
sigv4Allowed enum values:
sigv4<type=ntlm>object
Object to handle NTLM authentication when performing the test.
domainstring
Domain for the authentication to use when performing the test.
passwordstring
Password for the authentication to use when performing the test.
type [required]enum
The type of authentication to use when performing the test.
ntlmAllowed enum values:
ntlmusernamestring
Username for the authentication to use when performing the test.
workstationstring
Workstation for the authentication to use when performing the test.
<type=digest>object
Object to handle digest authentication when performing the test.
password [required]string
Password to use for the digest authentication.
type [required]enum
The type of basic authentication to use when performing the test.
digestAllowed enum values:
digestusername [required]string
Username to use for the digest authentication.
<type=oauth-client>object
Object to handle oauth client authentication when performing the test.
accessTokenUrl [required]string
Access token URL to use when performing the authentication.
audiencestring
Audience to use when performing the authentication.
clientId [required]string
Client ID to use when performing the authentication.
clientSecret [required]string
Client secret to use when performing the authentication.
resourcestring
Resource to use when performing the authentication.
scopestring
Scope to use when performing the authentication.
tokenApiAuthentication [required]enum
Type of token to use when performing the authentication.
Allowed enum values:
header, bodytype [required]enum
The type of basic authentication to use when performing the test.
oauth-clientAllowed enum values:
oauth-client<type=oauth-rop>object
Object to handle oauth rop authentication when performing the test.
accessTokenUrl [required]string
Access token URL to use when performing the authentication.
audiencestring
Audience to use when performing the authentication.
clientIdstring
Client ID to use when performing the authentication.
clientSecretstring
Client secret to use when performing the authentication.
password [required]string
Password to use when performing the authentication.
resourcestring
Resource to use when performing the authentication.
scopestring
Scope to use when performing the authentication.
tokenApiAuthentication [required]enum
Type of token to use when performing the authentication.
Allowed enum values:
header, bodytype [required]enum
The type of basic authentication to use when performing the test.
oauth-ropAllowed enum values:
oauth-ropusername [required]string
Username to use when performing the authentication.
<type=jwt>object
Object to handle JWT authentication when performing the test.
addClaimsobject
Standard JWT claims to automatically inject.
expboolean
Whether to inject the exp (expiration) claim.
iatboolean
Whether to inject the iat (issued at) claim.
algorithm [required]enum
Algorithm to use for the JWT authentication.
Allowed enum values:
HS256, RS256, ES256expiresInint64
Token time-to-live in seconds.
headerstring
Custom JWT header as a JSON string.
payload [required]string
JWT claims as a JSON string.
secret [required]string
Signing key for the JWT authentication. Use the shared secret for HS256
or the private key (PEM format) for RS256 and ES256.
tokenPrefixstring
Prefix added before the token in the Authorization header. Defaults to Bearer.
type [required]enum
The type of authentication to use when performing the test.
jwtAllowed enum values:
jwtbodystring
Body to include in the test.
bodyTypeenum
Type of the request body.
Allowed enum values:
text/plain, application/json, text/xml, text/html, application/x-www-form-urlencoded, graphql, application/octet-stream, multipart/form-datacallTypeenum
The type of call to perform. Used by gRPC steps (healthcheck, unary)
and MCP steps (init, tool_list, tool_call). Valid values depend on
the parent step's subtype.
Allowed enum values:
healthcheck, unary, init, tool_list, tool_callcertificateobject
Client certificate to use when performing the test request.
certobject
Define a request certificate.
contentstring
Content of the certificate or key.
filenamestring
File name for the certificate or key.
updatedAtstring
Date of update of the certificate or key, ISO format.
keyobject
Define a request certificate.
contentstring
Content of the certificate or key.
filenamestring
File name for the certificate or key.
updatedAtstring
Date of update of the certificate or key, ISO format.
certificateDomains[string]
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.
checkCertificateRevocationboolean
Check for certificate revocation.
compressedJsonDescriptorstring
A protobuf JSON descriptor that needs to be gzipped first then base64 encoded.
compressedProtoFilestring
A protobuf file that needs to be gzipped first then base64 encoded.
disableAiaIntermediateFetchingboolean
Disable fetching intermediate certificates from AIA.
dnsServerstring
DNS server to use for DNS tests.
dnsServerPort<oneOf>
DNS server port to use for DNS tests.
Object 1int64
Integer DNS server port number to use when performing the test.
Object 2string
String DNS server port number to use when performing the test. Supports templated variables.
files[object]
Files to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
bucketKeystring
Bucket key of the file.
contentstring
Content of the file.
encodingstring
Encoding of the file content. The only supported value is base64, indicating the content field contains base64-encoded data.
namestring
Name of the file.
originalFileNamestring
Original name of the file.
sizeint64
Size of the file.
typestring
Type of the file.
follow_redirectsboolean
Specifies whether or not the request follows redirects.
formobject
Form to be used as part of the request in the test. Only valid if bodyType is multipart/form-data.
<any-key>string
A single form entry.
headersobject
Headers to include when performing the test.
<any-key>string
A single Header.
hoststring
Host name to perform the test with.
httpVersionenum
HTTP version to use for a Synthetic test.
Allowed enum values:
http1, http2, anyignore_certificate_validationboolean
For SSL tests, whether the test should ignore certificate validation.
isMessageBase64Encodedboolean
Whether the message is base64 encoded.
mcpProtocolVersionenum
The MCP protocol version used by the step. See https://modelcontextprotocol.io/specification.
Allowed enum values:
2025-06-18messagestring
Message to send for UDP or WebSocket tests.
metadataobject
Metadata to include when performing the gRPC test.
<any-key>string
A single metadatum.
methodstring
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.
noSavingResponseBodyboolean
Determines whether or not to save the response body.
numberOfPacketsint32
Number of pings to use per test.
persistCookiesboolean
Persist cookies across redirects.
port<oneOf>
Port to use when performing the test.
Object 1int64
Integer Port number to use when performing the test.
Object 2string
String Port number to use when performing the test. Supports templated variables.
proxyobject
The proxy to perform the test.
headersobject
Headers to include when performing the test.
<any-key>string
A single Header.
url [required]string
URL of the proxy to perform the test.
queryobject
Query to use for the test.
servernamestring
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.
servicestring
The gRPC service on which you want to perform the gRPC call.
shouldTrackHopsboolean
Turns on a traceroute probe to discover all gateways along the path to the host destination.
timeoutdouble
Timeout in seconds for the test.
toolArgsobject
Arguments to pass to the MCP tool. Free-form object whose shape depends on the tool. Used when callType is tool_call.
toolNamestring
The name of the MCP tool to call. Required when callType is tool_call.
urlstring
URL to perform the test with.
variables[object]
Array of variables used for the test steps.
examplestring
Example for the variable.
idstring
ID for the variable. Global variables require an ID.
name [required]string
Name of the variable.
patternstring
Pattern of the variable.
secureboolean
Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type text.
type [required]enum
Type of browser test variable.
Allowed enum values:
element, email, global, textlocations [required][string]
Array of locations used to run the test.
message [required]string
Notification message associated with the test. Message can either be text or an empty string.
monitor_idint64
The associated monitor ID.
name [required]string
Name of the test.
options [required]object
Object describing the extra options for a Synthetic test.
accept_self_signedboolean
For SSL tests, whether or not the test should allow self signed certificates.
allow_insecureboolean
Allows loading insecure content for an HTTP request in an API test.
bits_ai_auto_investigateboolean
Whether Bits AI automatically investigates alerts from the test monitor.
blockedRequestPatterns[string]
Array of URL patterns to block.
captureNetworkPayloadsboolean
Capture HTTP request/response headers and bodies for Fetch/XHR calls made during browser tests.
checkCertificateRevocationboolean
For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP.
ciobject
CI/CD options for a Synthetic test.
executionRule [required]enum
Execution rule for a Synthetic test.
Allowed enum values:
blocking, non_blocking, skippeddevice_ids[string]
For browser test, array with the different device IDs used to run the test.
disableAiaIntermediateFetchingboolean
For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA.
disableCorsboolean
Whether or not to disable CORS mechanism.
disableCspboolean
Disable Content Security Policy for browser tests.
enableProfilingboolean
Enable profiling for browser tests.
enableSecurityTestingboolean
DEPRECATED Enable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.
follow_redirectsboolean
For API HTTP test, whether or not the test should follow redirects.
httpVersionenum
HTTP version to use for a Synthetic test.
Allowed enum values:
http1, http2, anyignoreServerCertificateErrorboolean
Ignore server certificate error for browser tests.
ignore_certificate_validationboolean
For SSL tests, whether the test should ignore certificate validation.
initialNavigationTimeoutint64
Timeout before declaring the initial step as failed (in seconds) for browser tests.
min_failure_durationint64
Minimum amount of time in failure required to trigger an alert.
min_location_failedint64
Minimum number of locations in failure required to trigger an alert.
monitor_namestring
The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
monitor_optionsobject
Object containing the options for a Synthetic test as a monitor (for example, renotification).
escalation_messagestring
Message to include in the escalation notification.
notification_preset_nameenum
The name of the preset for the notification for the monitor.
Allowed enum values:
show_all, hide_all, hide_query, hide_handles, hide_query_and_handles, show_only_snapshot, hide_handles_and_footerrenotify_intervalint64
Time interval before renotifying if the test is still failing (in minutes).
renotify_occurrencesint64
The number of times to renotify if the test is still failing.
monitor_priorityint32
Integer from 1 (high) to 5 (low) indicating alert severity.
noScreenshotboolean
Prevents saving screenshots of the steps.
restricted_roles[string]
DEPRECATED A list of role identifiers that can be pulled from the Roles API, for restricting read and write access. This field is deprecated. Use the restriction policies API to manage permissions.
retryobject
Object describing the retry strategy to apply to a Synthetic test.
countint64
Number of times a test needs to be retried before marking a location as failed. Defaults to 0.
intervaldouble
Time interval between retries (in milliseconds). Defaults to 300ms.
rumSettingsobject
The RUM data collection settings for the Synthetic browser test. Note: There are 3 ways to format RUM settings:
{ isEnabled: false }
RUM data is not collected.
{ isEnabled: true }
RUM data is collected from the Synthetic test's default application.
{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", clientTokenId: 12345 }
RUM data is collected using the specified application.
applicationIdstring
RUM application ID used to collect RUM data for the browser test.
clientTokenIdint64
RUM application API key ID used to collect RUM data for the browser test.
isEnabled [required]boolean
Determines whether RUM data is collected during test runs.
schedulingobject
Object containing timeframes and timezone used for advanced scheduling.
timeframes [required][object]
Array containing objects describing the scheduling pattern to apply to each day.
day [required]int32
Number representing the day of the week.
from [required]string
The hour of the day on which scheduling starts.
to [required]string
The hour of the day on which scheduling ends.
timezone [required]string
Timezone in which the timeframe is based.
tick_everyint64
The frequency at which to run the Synthetic test (in seconds).
public_idstring
The public ID of the test.
statusenum
Define whether you want to start (live) or pause (paused) a
Synthetic test.
Allowed enum values:
live, pausedsteps[object]
Array of steps for the test.
allowFailureboolean
A boolean set to allow this step to fail.
alwaysExecuteboolean
A boolean set to always execute this step even if the previous step failed or was skipped.
exitIfSucceedboolean
A boolean set to exit the test if the step succeeds.
isCriticalboolean
A boolean to use in addition to allowFailure to determine if the test should be marked as failed when the step fails.
namestring
The name of the step.
noScreenshotboolean
A boolean set to skip taking a screenshot for the step.
paramsobject
The parameters of the step.
public_idstring
The public ID of the step.
timeoutint64
The time before declaring a step failed.
typeenum
Step type used in your Synthetic test.
Allowed enum values:
assertCurrentUrl, assertElementAttribute, assertElementContent, assertElementPresent, assertEmail, assertFileDownload, assertFromJavascript, assertPageContains, assertPageLacks, assertRequestsShow 19 more
click, drag, drop, extractFromJavascript, extractFromEmailBody, extractVariable, goToEmailLink, goToUrl, goToUrlAndMeasureTti, hover, playSubTest, pressKey, refresh, runApiTest, scroll, selectOption, typeText, uploadFiles, waittags[string]
Array of tags attached to the test.
type [required]enum
Type of the Synthetic test, browser.
browserAllowed enum values:
browser{
"config": {
"assertions": [
{
"operator": "contains",
"property": "string",
"target": 0,
"timingsScope": "string",
"type": "statusCode"
}
],
"configVariables": [
{
"example": "string",
"id": "string",
"name": "VARIABLE_NAME",
"pattern": "string",
"secure": false,
"type": "text"
}
],
"request": {
"allow_insecure": false,
"basicAuth": {
"password": "PaSSw0RD!",
"type": "web",
"username": "my_username"
},
"body": "string",
"bodyType": "text/plain",
"callType": "unary",
"certificate": {
"cert": {
"content": "string",
"filename": "string",
"updatedAt": "string"
},
"key": {
"content": "string",
"filename": "string",
"updatedAt": "string"
}
},
"certificateDomains": [],
"checkCertificateRevocation": false,
"compressedJsonDescriptor": "string",
"compressedProtoFile": "string",
"disableAiaIntermediateFetching": false,
"dnsServer": "string",
"dnsServerPort": {
"description": "undefined",
"format": "undefined",
"type": "undefined"
},
"files": [
{
"bucketKey": "string",
"content": "string",
"encoding": "string",
"name": "string",
"originalFileName": "string",
"size": "integer",
"type": "string"
}
],
"follow_redirects": false,
"form": {
"<any-key>": "string"
},
"headers": {
"<any-key>": "string"
},
"host": "string",
"httpVersion": "string",
"ignore_certificate_validation": false,
"isMessageBase64Encoded": false,
"mcpProtocolVersion": "2025-06-18",
"message": "string",
"metadata": {
"<any-key>": "string"
},
"method": "string",
"noSavingResponseBody": false,
"numberOfPackets": "integer",
"persistCookies": false,
"port": {
"description": "undefined",
"format": "undefined",
"type": "undefined"
},
"proxy": {
"headers": {
"<any-key>": "string"
},
"url": "https://example.com"
},
"query": {},
"servername": "string",
"service": "Greeter",
"shouldTrackHops": false,
"timeout": "number",
"toolArgs": {},
"toolName": "search",
"url": "https://example.com"
},
"setCookie": "string",
"variables": [
{
"example": "string",
"id": "string",
"name": "VARIABLE_NAME",
"pattern": "string",
"secure": false,
"type": "text"
}
]
},
"locations": [
"aws:eu-west-3"
],
"message": "",
"monitor_id": "integer",
"name": "Example test name",
"options": {
"accept_self_signed": false,
"allow_insecure": false,
"bits_ai_auto_investigate": false,
"blockedRequestPatterns": [],
"captureNetworkPayloads": false,
"checkCertificateRevocation": false,
"ci": {
"executionRule": "blocking"
},
"device_ids": [
"chrome.laptop_large"
],
"disableAiaIntermediateFetching": false,
"disableCors": false,
"disableCsp": false,
"enableProfiling": false,
"enableSecurityTesting": false,
"follow_redirects": false,
"httpVersion": "string",
"ignoreServerCertificateError": false,
"ignore_certificate_validation": false,
"initialNavigationTimeout": "integer",
"min_failure_duration": "integer",
"min_location_failed": "integer",
"monitor_name": "string",
"monitor_options": {
"escalation_message": "string",
"notification_preset_name": "string",
"renotify_interval": "integer",
"renotify_occurrences": "integer"
},
"monitor_priority": "integer",
"noScreenshot": false,
"restricted_roles": [
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
],
"retry": {
"count": "integer",
"interval": "number"
},
"rumSettings": {
"applicationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"clientTokenId": 12345,
"isEnabled": true
},
"scheduling": {
"timeframes": [
{
"day": 1,
"from": "07:00",
"to": "16:00"
}
],
"timezone": "America/New_York"
},
"tick_every": "integer"
},
"public_id": "string",
"status": "live",
"steps": [
{
"allowFailure": false,
"alwaysExecute": false,
"exitIfSucceed": false,
"isCritical": false,
"name": "string",
"noScreenshot": false,
"params": {},
"public_id": "string",
"timeout": "integer",
"type": "assertElementContent"
}
],
"tags": [
"env:prod"
],
"type": "browser"
}- JSON format is wrong - Creation failed
Error response object.
Field
Type
Description
errors [required][string]
Array of errors returned by the API.
{
"errors": [
"Bad Request"
]
}Test quota is reached
Error response object.
Field
Type
Description
errors [required][string]
Array of errors returned by the API.
{
"errors": [
"Bad Request"
]
}Forbidden
Error response object.
Field
Type
Description
errors [required][string]
Array of errors returned by the API.
{
"errors": [
"Bad Request"
]
}Too many requests
Error response object.
Field
Type
Description
errors [required][string]
Array of errors returned by the API.
{
"errors": [
"Bad Request"
]
}Code Example
Create a browser test returns "OK - Returns saved rumSettings." response
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com",
"certificateDomains": [
"https://datadoghq.com"
]
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"tablet"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"rumSettings": {
"isEnabled": true,
"applicationId": "mockApplicationId",
"clientTokenId": 12345
},
"tick_every": 300,
"ci": {
"executionRule": "skipped"
},
"ignoreServerCertificateError": true,
"disableCsp": true,
"initialNavigationTimeout": 200
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com",
"certificateDomains": [
"https://datadoghq.com"
]
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"tablet"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"rumSettings": {
"isEnabled": true,
"applicationId": "mockApplicationId",
"clientTokenId": 12345
},
"tick_every": 300,
"ci": {
"executionRule": "skipped"
},
"ignoreServerCertificateError": true,
"disableCsp": true,
"initialNavigationTimeout": 200
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com",
"certificateDomains": [
"https://datadoghq.com"
]
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"tablet"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"rumSettings": {
"isEnabled": true,
"applicationId": "mockApplicationId",
"clientTokenId": 12345
},
"tick_every": 300,
"ci": {
"executionRule": "skipped"
},
"ignoreServerCertificateError": true,
"disableCsp": true,
"initialNavigationTimeout": 200
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com",
"certificateDomains": [
"https://datadoghq.com"
]
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"tablet"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"rumSettings": {
"isEnabled": true,
"applicationId": "mockApplicationId",
"clientTokenId": 12345
},
"tick_every": 300,
"ci": {
"executionRule": "skipped"
},
"ignoreServerCertificateError": true,
"disableCsp": true,
"initialNavigationTimeout": 200
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com",
"certificateDomains": [
"https://datadoghq.com"
]
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"tablet"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"rumSettings": {
"isEnabled": true,
"applicationId": "mockApplicationId",
"clientTokenId": 12345
},
"tick_every": 300,
"ci": {
"executionRule": "skipped"
},
"ignoreServerCertificateError": true,
"disableCsp": true,
"initialNavigationTimeout": 200
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com",
"certificateDomains": [
"https://datadoghq.com"
]
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"tablet"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"rumSettings": {
"isEnabled": true,
"applicationId": "mockApplicationId",
"clientTokenId": 12345
},
"tick_every": 300,
"ci": {
"executionRule": "skipped"
},
"ignoreServerCertificateError": true,
"disableCsp": true,
"initialNavigationTimeout": 200
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com",
"certificateDomains": [
"https://datadoghq.com"
]
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"tablet"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"rumSettings": {
"isEnabled": true,
"applicationId": "mockApplicationId",
"clientTokenId": 12345
},
"tick_every": 300,
"ci": {
"executionRule": "skipped"
},
"ignoreServerCertificateError": true,
"disableCsp": true,
"initialNavigationTimeout": 200
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com",
"certificateDomains": [
"https://datadoghq.com"
]
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"tablet"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"rumSettings": {
"isEnabled": true,
"applicationId": "mockApplicationId",
"clientTokenId": 12345
},
"tick_every": 300,
"ci": {
"executionRule": "skipped"
},
"ignoreServerCertificateError": true,
"disableCsp": true,
"initialNavigationTimeout": 200
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com",
"certificateDomains": [
"https://datadoghq.com"
]
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"tablet"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"rumSettings": {
"isEnabled": true,
"applicationId": "mockApplicationId",
"clientTokenId": 12345
},
"tick_every": 300,
"ci": {
"executionRule": "skipped"
},
"ignoreServerCertificateError": true,
"disableCsp": true,
"initialNavigationTimeout": 200
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOFCreate a browser test returns "OK - Returns the created test details." response
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"variables": [
{
"type": "text",
"name": "TEST_VARIABLE",
"pattern": "secret",
"secure": true,
"example": "secret"
}
],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text",
"secure": true
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com"
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"chrome.laptop_large"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"tick_every": 300,
"enableProfiling": true,
"enableSecurityTesting": true
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"alwaysExecute": true,
"exitIfSucceed": true,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"variables": [
{
"type": "text",
"name": "TEST_VARIABLE",
"pattern": "secret",
"secure": true,
"example": "secret"
}
],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text",
"secure": true
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com"
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"chrome.laptop_large"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"tick_every": 300,
"enableProfiling": true,
"enableSecurityTesting": true
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"alwaysExecute": true,
"exitIfSucceed": true,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"variables": [
{
"type": "text",
"name": "TEST_VARIABLE",
"pattern": "secret",
"secure": true,
"example": "secret"
}
],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text",
"secure": true
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com"
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"chrome.laptop_large"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"tick_every": 300,
"enableProfiling": true,
"enableSecurityTesting": true
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"alwaysExecute": true,
"exitIfSucceed": true,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"variables": [
{
"type": "text",
"name": "TEST_VARIABLE",
"pattern": "secret",
"secure": true,
"example": "secret"
}
],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text",
"secure": true
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com"
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"chrome.laptop_large"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"tick_every": 300,
"enableProfiling": true,
"enableSecurityTesting": true
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"alwaysExecute": true,
"exitIfSucceed": true,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"variables": [
{
"type": "text",
"name": "TEST_VARIABLE",
"pattern": "secret",
"secure": true,
"example": "secret"
}
],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text",
"secure": true
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com"
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"chrome.laptop_large"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"tick_every": 300,
"enableProfiling": true,
"enableSecurityTesting": true
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"alwaysExecute": true,
"exitIfSucceed": true,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"variables": [
{
"type": "text",
"name": "TEST_VARIABLE",
"pattern": "secret",
"secure": true,
"example": "secret"
}
],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text",
"secure": true
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com"
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"chrome.laptop_large"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"tick_every": 300,
"enableProfiling": true,
"enableSecurityTesting": true
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"alwaysExecute": true,
"exitIfSucceed": true,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"variables": [
{
"type": "text",
"name": "TEST_VARIABLE",
"pattern": "secret",
"secure": true,
"example": "secret"
}
],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text",
"secure": true
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com"
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"chrome.laptop_large"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"tick_every": 300,
"enableProfiling": true,
"enableSecurityTesting": true
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"alwaysExecute": true,
"exitIfSucceed": true,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"variables": [
{
"type": "text",
"name": "TEST_VARIABLE",
"pattern": "secret",
"secure": true,
"example": "secret"
}
],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text",
"secure": true
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com"
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"chrome.laptop_large"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"tick_every": 300,
"enableProfiling": true,
"enableSecurityTesting": true
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"alwaysExecute": true,
"exitIfSucceed": true,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"variables": [
{
"type": "text",
"name": "TEST_VARIABLE",
"pattern": "secret",
"secure": true,
"example": "secret"
}
],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text",
"secure": true
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com"
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"chrome.laptop_large"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"tick_every": 300,
"enableProfiling": true,
"enableSecurityTesting": true
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"alwaysExecute": true,
"exitIfSucceed": true,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOFCreate a browser test with advanced scheduling options returns "OK - Returns the created test details." response
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com"
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"tablet"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"tick_every": 300,
"scheduling": {
"timeframes": [
{
"day": 1,
"from": "07:00",
"to": "16:00"
},
{
"day": 3,
"from": "07:00",
"to": "16:00"
}
],
"timezone": "America/New_York"
}
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com"
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"tablet"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"tick_every": 300,
"scheduling": {
"timeframes": [
{
"day": 1,
"from": "07:00",
"to": "16:00"
},
{
"day": 3,
"from": "07:00",
"to": "16:00"
}
],
"timezone": "America/New_York"
}
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com"
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"tablet"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"tick_every": 300,
"scheduling": {
"timeframes": [
{
"day": 1,
"from": "07:00",
"to": "16:00"
},
{
"day": 3,
"from": "07:00",
"to": "16:00"
}
],
"timezone": "America/New_York"
}
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com"
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"tablet"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"tick_every": 300,
"scheduling": {
"timeframes": [
{
"day": 1,
"from": "07:00",
"to": "16:00"
},
{
"day": 3,
"from": "07:00",
"to": "16:00"
}
],
"timezone": "America/New_York"
}
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com"
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"tablet"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"tick_every": 300,
"scheduling": {
"timeframes": [
{
"day": 1,
"from": "07:00",
"to": "16:00"
},
{
"day": 3,
"from": "07:00",
"to": "16:00"
}
],
"timezone": "America/New_York"
}
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com"
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"tablet"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"tick_every": 300,
"scheduling": {
"timeframes": [
{
"day": 1,
"from": "07:00",
"to": "16:00"
},
{
"day": 3,
"from": "07:00",
"to": "16:00"
}
],
"timezone": "America/New_York"
}
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com"
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"tablet"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"tick_every": 300,
"scheduling": {
"timeframes": [
{
"day": 1,
"from": "07:00",
"to": "16:00"
},
{
"day": 3,
"from": "07:00",
"to": "16:00"
}
],
"timezone": "America/New_York"
}
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com"
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"tablet"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"tick_every": 300,
"scheduling": {
"timeframes": [
{
"day": 1,
"from": "07:00",
"to": "16:00"
},
{
"day": 3,
"from": "07:00",
"to": "16:00"
}
],
"timezone": "America/New_York"
}
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/synthetics/tests/browser" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"config": {
"assertions": [],
"configVariables": [
{
"example": "content-type",
"name": "PROPERTY",
"pattern": "content-type",
"type": "text"
}
],
"request": {
"method": "GET",
"url": "https://datadoghq.com"
},
"setCookie": "name:test"
},
"locations": [
"aws:us-east-2"
],
"message": "Test message",
"name": "Example-Synthetic",
"options": {
"accept_self_signed": false,
"allow_insecure": true,
"device_ids": [
"tablet"
],
"disableCors": true,
"follow_redirects": true,
"min_failure_duration": 10,
"min_location_failed": 1,
"noScreenshot": true,
"retry": {
"count": 2,
"interval": 10
},
"tick_every": 300,
"scheduling": {
"timeframes": [
{
"day": 1,
"from": "07:00",
"to": "16:00"
},
{
"day": 3,
"from": "07:00",
"to": "16:00"
}
],
"timezone": "America/New_York"
}
},
"tags": [
"testing:browser"
],
"type": "browser",
"steps": [
{
"allowFailure": false,
"isCritical": true,
"name": "Refresh page",
"params": {},
"type": "refresh"
}
]
}
EOFCreate a browser test returns "OK - Returns saved rumSettings." response
// Create a browser test returns "OK - Returns saved rumSettings." response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)
func main() {
body := datadogV1.SyntheticsBrowserTest{
Config: datadogV1.SyntheticsBrowserTestConfig{
Assertions: []datadogV1.SyntheticsAssertion{},
ConfigVariables: []datadogV1.SyntheticsConfigVariable{
{
Example: datadog.PtrString("content-type"),
Name: "PROPERTY",
Pattern: datadog.PtrString("content-type"),
Type: datadogV1.SYNTHETICSCONFIGVARIABLETYPE_TEXT,
},
},
Request: datadogV1.SyntheticsTestRequest{
Method: datadog.PtrString("GET"),
Url: datadog.PtrString("https://datadoghq.com"),
CertificateDomains: []string{
"https://datadoghq.com",
},
},
SetCookie: datadog.PtrString("name:test"),
},
Locations: []string{
"aws:us-east-2",
},
Message: "Test message",
Name: "Example-Synthetic",
Options: datadogV1.SyntheticsTestOptions{
AcceptSelfSigned: datadog.PtrBool(false),
AllowInsecure: datadog.PtrBool(true),
DeviceIds: []string{
"tablet",
},
DisableCors: datadog.PtrBool(true),
FollowRedirects: datadog.PtrBool(true),
MinFailureDuration: datadog.PtrInt64(10),
MinLocationFailed: datadog.PtrInt64(1),
NoScreenshot: datadog.PtrBool(true),
Retry: &datadogV1.SyntheticsTestOptionsRetry{
Count: datadog.PtrInt64(2),
Interval: datadog.PtrFloat64(10),
},
RumSettings: &datadogV1.SyntheticsBrowserTestRumSettings{
IsEnabled: true,
ApplicationId: datadog.PtrString("mockApplicationId"),
ClientTokenId: datadog.PtrInt64(12345),
},
TickEvery: datadog.PtrInt64(300),
Ci: &datadogV1.SyntheticsTestCiOptions{
ExecutionRule: datadogV1.SYNTHETICSTESTEXECUTIONRULE_SKIPPED,
},
IgnoreServerCertificateError: datadog.PtrBool(true),
DisableCsp: datadog.PtrBool(true),
InitialNavigationTimeout: datadog.PtrInt64(200),
},
Tags: []string{
"testing:browser",
},
Type: datadogV1.SYNTHETICSBROWSERTESTTYPE_BROWSER,
Steps: []datadogV1.SyntheticsStep{
{
AllowFailure: datadog.PtrBool(false),
IsCritical: datadog.PtrBool(true),
Name: datadog.PtrString("Refresh page"),
Params: new(interface{}),
Type: datadogV1.SYNTHETICSSTEPTYPE_REFRESH.Ptr(),
},
},
}
ctx := datadog.NewDefaultContext(context.Background())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV1.NewSyntheticsApi(apiClient)
resp, r, err := api.CreateSyntheticsBrowserTest(ctx, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SyntheticsApi.CreateSyntheticsBrowserTest`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `SyntheticsApi.CreateSyntheticsBrowserTest`:\n%s\n", responseContent)
}
Create a browser test returns "OK - Returns the created test details." response
// Create a browser test returns "OK - Returns the created test details." response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)
func main() {
body := datadogV1.SyntheticsBrowserTest{
Config: datadogV1.SyntheticsBrowserTestConfig{
Assertions: []datadogV1.SyntheticsAssertion{},
Variables: []datadogV1.SyntheticsBrowserVariable{
{
Type: datadogV1.SYNTHETICSBROWSERVARIABLETYPE_TEXT,
Name: "TEST_VARIABLE",
Pattern: datadog.PtrString("secret"),
Secure: datadog.PtrBool(true),
Example: datadog.PtrString("secret"),
},
},
ConfigVariables: []datadogV1.SyntheticsConfigVariable{
{
Example: datadog.PtrString("content-type"),
Name: "PROPERTY",
Pattern: datadog.PtrString("content-type"),
Type: datadogV1.SYNTHETICSCONFIGVARIABLETYPE_TEXT,
Secure: datadog.PtrBool(true),
},
},
Request: datadogV1.SyntheticsTestRequest{
Method: datadog.PtrString("GET"),
Url: datadog.PtrString("https://datadoghq.com"),
},
SetCookie: datadog.PtrString("name:test"),
},
Locations: []string{
"aws:us-east-2",
},
Message: "Test message",
Name: "Example-Synthetic",
Options: datadogV1.SyntheticsTestOptions{
AcceptSelfSigned: datadog.PtrBool(false),
AllowInsecure: datadog.PtrBool(true),
DeviceIds: []string{
"chrome.laptop_large",
},
DisableCors: datadog.PtrBool(true),
FollowRedirects: datadog.PtrBool(true),
MinFailureDuration: datadog.PtrInt64(10),
MinLocationFailed: datadog.PtrInt64(1),
NoScreenshot: datadog.PtrBool(true),
Retry: &datadogV1.SyntheticsTestOptionsRetry{
Count: datadog.PtrInt64(2),
Interval: datadog.PtrFloat64(10),
},
TickEvery: datadog.PtrInt64(300),
EnableProfiling: datadog.PtrBool(true),
EnableSecurityTesting: datadog.PtrBool(true),
},
Tags: []string{
"testing:browser",
},
Type: datadogV1.SYNTHETICSBROWSERTESTTYPE_BROWSER,
Steps: []datadogV1.SyntheticsStep{
{
AllowFailure: datadog.PtrBool(false),
AlwaysExecute: datadog.PtrBool(true),
ExitIfSucceed: datadog.PtrBool(true),
IsCritical: datadog.PtrBool(true),
Name: datadog.PtrString("Refresh page"),
Params: new(interface{}),
Type: datadogV1.SYNTHETICSSTEPTYPE_REFRESH.Ptr(),
},
},
}
ctx := datadog.NewDefaultContext(context.Background())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV1.NewSyntheticsApi(apiClient)
resp, r, err := api.CreateSyntheticsBrowserTest(ctx, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SyntheticsApi.CreateSyntheticsBrowserTest`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `SyntheticsApi.CreateSyntheticsBrowserTest`:\n%s\n", responseContent)
}
Create a browser test with advanced scheduling options returns "OK - Returns the created test details." response
// Create a browser test with advanced scheduling options returns "OK - Returns the created test details." response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)
func main() {
body := datadogV1.SyntheticsBrowserTest{
Config: datadogV1.SyntheticsBrowserTestConfig{
Assertions: []datadogV1.SyntheticsAssertion{},
ConfigVariables: []datadogV1.SyntheticsConfigVariable{
{
Example: datadog.PtrString("content-type"),
Name: "PROPERTY",
Pattern: datadog.PtrString("content-type"),
Type: datadogV1.SYNTHETICSCONFIGVARIABLETYPE_TEXT,
},
},
Request: datadogV1.SyntheticsTestRequest{
Method: datadog.PtrString("GET"),
Url: datadog.PtrString("https://datadoghq.com"),
},
SetCookie: datadog.PtrString("name:test"),
},
Locations: []string{
"aws:us-east-2",
},
Message: "Test message",
Name: "Example-Synthetic",
Options: datadogV1.SyntheticsTestOptions{
AcceptSelfSigned: datadog.PtrBool(false),
AllowInsecure: datadog.PtrBool(true),
DeviceIds: []string{
"tablet",
},
DisableCors: datadog.PtrBool(true),
FollowRedirects: datadog.PtrBool(true),
MinFailureDuration: datadog.PtrInt64(10),
MinLocationFailed: datadog.PtrInt64(1),
NoScreenshot: datadog.PtrBool(true),
Retry: &datadogV1.SyntheticsTestOptionsRetry{
Count: datadog.PtrInt64(2),
Interval: datadog.PtrFloat64(10),
},
TickEvery: datadog.PtrInt64(300),
Scheduling: &datadogV1.SyntheticsTestOptionsScheduling{
Timeframes: []datadogV1.SyntheticsTestOptionsSchedulingTimeframe{
{
Day: 1,
From: "07:00",
To: "16:00",
},
{
Day: 3,
From: "07:00",
To: "16:00",
},
},
Timezone: "America/New_York",
},
},
Tags: []string{
"testing:browser",
},
Type: datadogV1.SYNTHETICSBROWSERTESTTYPE_BROWSER,
Steps: []datadogV1.SyntheticsStep{
{
AllowFailure: datadog.PtrBool(false),
IsCritical: datadog.PtrBool(true),
Name: datadog.PtrString("Refresh page"),
Params: new(interface{}),
Type: datadogV1.SYNTHETICSSTEPTYPE_REFRESH.Ptr(),
},
},
}
ctx := datadog.NewDefaultContext(context.Background())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV1.NewSyntheticsApi(apiClient)
resp, r, err := api.CreateSyntheticsBrowserTest(ctx, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SyntheticsApi.CreateSyntheticsBrowserTest`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `SyntheticsApi.CreateSyntheticsBrowserTest`:\n%s\n", responseContent)
}
Instructions
First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"Create a browser test returns "OK - Returns saved rumSettings." response
// Create a browser test returns "OK - Returns saved rumSettings." response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.SyntheticsApi;
import com.datadog.api.client.v1.model.SyntheticsBrowserTest;
import com.datadog.api.client.v1.model.SyntheticsBrowserTestConfig;
import com.datadog.api.client.v1.model.SyntheticsBrowserTestRumSettings;
import com.datadog.api.client.v1.model.SyntheticsBrowserTestType;
import com.datadog.api.client.v1.model.SyntheticsConfigVariable;
import com.datadog.api.client.v1.model.SyntheticsConfigVariableType;
import com.datadog.api.client.v1.model.SyntheticsStep;
import com.datadog.api.client.v1.model.SyntheticsStepType;
import com.datadog.api.client.v1.model.SyntheticsTestCiOptions;
import com.datadog.api.client.v1.model.SyntheticsTestExecutionRule;
import com.datadog.api.client.v1.model.SyntheticsTestOptions;
import com.datadog.api.client.v1.model.SyntheticsTestOptionsRetry;
import com.datadog.api.client.v1.model.SyntheticsTestRequest;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
SyntheticsApi apiInstance = new SyntheticsApi(defaultClient);
SyntheticsBrowserTest body =
new SyntheticsBrowserTest()
.config(
new SyntheticsBrowserTestConfig()
.configVariables(
Collections.singletonList(
new SyntheticsConfigVariable()
.example("content-type")
.name("PROPERTY")
.pattern("content-type")
.type(SyntheticsConfigVariableType.TEXT)))
.request(
new SyntheticsTestRequest()
.method("GET")
.url("https://datadoghq.com")
.certificateDomains(Collections.singletonList("https://datadoghq.com")))
.setCookie("name:test"))
.locations(Collections.singletonList("aws:us-east-2"))
.message("Test message")
.name("Example-Synthetic")
.options(
new SyntheticsTestOptions()
.acceptSelfSigned(false)
.allowInsecure(true)
.deviceIds(Collections.singletonList("tablet"))
.disableCors(true)
.followRedirects(true)
.minFailureDuration(10L)
.minLocationFailed(1L)
.noScreenshot(true)
.retry(new SyntheticsTestOptionsRetry().count(2L).interval(10.0))
.rumSettings(
new SyntheticsBrowserTestRumSettings()
.isEnabled(true)
.applicationId("mockApplicationId")
.clientTokenId(12345L))
.tickEvery(300L)
.ci(
new SyntheticsTestCiOptions()
.executionRule(SyntheticsTestExecutionRule.SKIPPED))
.ignoreServerCertificateError(true)
.disableCsp(true)
.initialNavigationTimeout(200L))
.tags(Collections.singletonList("testing:browser"))
.type(SyntheticsBrowserTestType.BROWSER)
.steps(
Collections.singletonList(
new SyntheticsStep()
.allowFailure(false)
.isCritical(true)
.name("Refresh page")
.params(new Object())
.type(SyntheticsStepType.REFRESH)));
try {
SyntheticsBrowserTest result = apiInstance.createSyntheticsBrowserTest(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SyntheticsApi#createSyntheticsBrowserTest");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Create a browser test returns "OK - Returns the created test details." response
// Create a browser test returns "OK - Returns the created test details." response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.SyntheticsApi;
import com.datadog.api.client.v1.model.SyntheticsBrowserTest;
import com.datadog.api.client.v1.model.SyntheticsBrowserTestConfig;
import com.datadog.api.client.v1.model.SyntheticsBrowserTestType;
import com.datadog.api.client.v1.model.SyntheticsBrowserVariable;
import com.datadog.api.client.v1.model.SyntheticsBrowserVariableType;
import com.datadog.api.client.v1.model.SyntheticsConfigVariable;
import com.datadog.api.client.v1.model.SyntheticsConfigVariableType;
import com.datadog.api.client.v1.model.SyntheticsStep;
import com.datadog.api.client.v1.model.SyntheticsStepType;
import com.datadog.api.client.v1.model.SyntheticsTestOptions;
import com.datadog.api.client.v1.model.SyntheticsTestOptionsRetry;
import com.datadog.api.client.v1.model.SyntheticsTestRequest;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
SyntheticsApi apiInstance = new SyntheticsApi(defaultClient);
SyntheticsBrowserTest body =
new SyntheticsBrowserTest()
.config(
new SyntheticsBrowserTestConfig()
.variables(
Collections.singletonList(
new SyntheticsBrowserVariable()
.type(SyntheticsBrowserVariableType.TEXT)
.name("TEST_VARIABLE")
.pattern("secret")
.secure(true)
.example("secret")))
.configVariables(
Collections.singletonList(
new SyntheticsConfigVariable()
.example("content-type")
.name("PROPERTY")
.pattern("content-type")
.type(SyntheticsConfigVariableType.TEXT)
.secure(true)))
.request(new SyntheticsTestRequest().method("GET").url("https://datadoghq.com"))
.setCookie("name:test"))
.locations(Collections.singletonList("aws:us-east-2"))
.message("Test message")
.name("Example-Synthetic")
.options(
new SyntheticsTestOptions()
.acceptSelfSigned(false)
.allowInsecure(true)
.deviceIds(Collections.singletonList("chrome.laptop_large"))
.disableCors(true)
.followRedirects(true)
.minFailureDuration(10L)
.minLocationFailed(1L)
.noScreenshot(true)
.retry(new SyntheticsTestOptionsRetry().count(2L).interval(10.0))
.tickEvery(300L)
.enableProfiling(true)
.enableSecurityTesting(true))
.tags(Collections.singletonList("testing:browser"))
.type(SyntheticsBrowserTestType.BROWSER)
.steps(
Collections.singletonList(
new SyntheticsStep()
.allowFailure(false)
.alwaysExecute(true)
.exitIfSucceed(true)
.isCritical(true)
.name("Refresh page")
.params(new Object())
.type(SyntheticsStepType.REFRESH)));
try {
SyntheticsBrowserTest result = apiInstance.createSyntheticsBrowserTest(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SyntheticsApi#createSyntheticsBrowserTest");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Create a browser test with advanced scheduling options returns "OK - Returns the created test details." response
// Create a browser test with advanced scheduling options returns "OK - Returns the created test
// details." response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.SyntheticsApi;
import com.datadog.api.client.v1.model.SyntheticsBrowserTest;
import com.datadog.api.client.v1.model.SyntheticsBrowserTestConfig;
import com.datadog.api.client.v1.model.SyntheticsBrowserTestType;
import com.datadog.api.client.v1.model.SyntheticsConfigVariable;
import com.datadog.api.client.v1.model.SyntheticsConfigVariableType;
import com.datadog.api.client.v1.model.SyntheticsStep;
import com.datadog.api.client.v1.model.SyntheticsStepType;
import com.datadog.api.client.v1.model.SyntheticsTestOptions;
import com.datadog.api.client.v1.model.SyntheticsTestOptionsRetry;
import com.datadog.api.client.v1.model.SyntheticsTestOptionsScheduling;
import com.datadog.api.client.v1.model.SyntheticsTestOptionsSchedulingTimeframe;
import com.datadog.api.client.v1.model.SyntheticsTestRequest;
import java.util.Arrays;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
SyntheticsApi apiInstance = new SyntheticsApi(defaultClient);
SyntheticsBrowserTest body =
new SyntheticsBrowserTest()
.config(
new SyntheticsBrowserTestConfig()
.configVariables(
Collections.singletonList(
new SyntheticsConfigVariable()
.example("content-type")
.name("PROPERTY")
.pattern("content-type")
.type(SyntheticsConfigVariableType.TEXT)))
.request(new SyntheticsTestRequest().method("GET").url("https://datadoghq.com"))
.setCookie("name:test"))
.locations(Collections.singletonList("aws:us-east-2"))
.message("Test message")
.name("Example-Synthetic")
.options(
new SyntheticsTestOptions()
.acceptSelfSigned(false)
.allowInsecure(true)
.deviceIds(Collections.singletonList("tablet"))
.disableCors(true)
.followRedirects(true)
.minFailureDuration(10L)
.minLocationFailed(1L)
.noScreenshot(true)
.retry(new SyntheticsTestOptionsRetry().count(2L).interval(10.0))
.tickEvery(300L)
.scheduling(
new SyntheticsTestOptionsScheduling()
.timeframes(
Arrays.asList(
new SyntheticsTestOptionsSchedulingTimeframe()
.day(1)
.from("07:00")
.to("16:00"),
new SyntheticsTestOptionsSchedulingTimeframe()
.day(3)
.from("07:00")
.to("16:00")))
.timezone("America/New_York")))
.tags(Collections.singletonList("testing:browser"))
.type(SyntheticsBrowserTestType.BROWSER)
.steps(
Collections.singletonList(
new SyntheticsStep()
.allowFailure(false)
.isCritical(true)
.name("Refresh page")
.params(new Object())
.type(SyntheticsStepType.REFRESH)));
try {
SyntheticsBrowserTest result = apiInstance.createSyntheticsBrowserTest(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SyntheticsApi#createSyntheticsBrowserTest");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Instructions
First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"Create a browser test returns "OK - Returns saved rumSettings." response
"""
Create a browser test returns "OK - Returns saved rumSettings." response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.synthetics_api import SyntheticsApi
from datadog_api_client.v1.model.synthetics_browser_test import SyntheticsBrowserTest
from datadog_api_client.v1.model.synthetics_browser_test_config import SyntheticsBrowserTestConfig
from datadog_api_client.v1.model.synthetics_browser_test_rum_settings import SyntheticsBrowserTestRumSettings
from datadog_api_client.v1.model.synthetics_browser_test_type import SyntheticsBrowserTestType
from datadog_api_client.v1.model.synthetics_config_variable import SyntheticsConfigVariable
from datadog_api_client.v1.model.synthetics_config_variable_type import SyntheticsConfigVariableType
from datadog_api_client.v1.model.synthetics_step import SyntheticsStep
from datadog_api_client.v1.model.synthetics_step_type import SyntheticsStepType
from datadog_api_client.v1.model.synthetics_test_ci_options import SyntheticsTestCiOptions
from datadog_api_client.v1.model.synthetics_test_execution_rule import SyntheticsTestExecutionRule
from datadog_api_client.v1.model.synthetics_test_options import SyntheticsTestOptions
from datadog_api_client.v1.model.synthetics_test_options_retry import SyntheticsTestOptionsRetry
from datadog_api_client.v1.model.synthetics_test_request import SyntheticsTestRequest
body = SyntheticsBrowserTest(
config=SyntheticsBrowserTestConfig(
assertions=[],
config_variables=[
SyntheticsConfigVariable(
example="content-type",
name="PROPERTY",
pattern="content-type",
type=SyntheticsConfigVariableType.TEXT,
),
],
request=SyntheticsTestRequest(
method="GET",
url="https://datadoghq.com",
certificate_domains=[
"https://datadoghq.com",
],
),
set_cookie="name:test",
),
locations=[
"aws:us-east-2",
],
message="Test message",
name="Example-Synthetic",
options=SyntheticsTestOptions(
accept_self_signed=False,
allow_insecure=True,
device_ids=[
"tablet",
],
disable_cors=True,
follow_redirects=True,
min_failure_duration=10,
min_location_failed=1,
no_screenshot=True,
retry=SyntheticsTestOptionsRetry(
count=2,
interval=10.0,
),
rum_settings=SyntheticsBrowserTestRumSettings(
is_enabled=True,
application_id="mockApplicationId",
client_token_id=12345,
),
tick_every=300,
ci=SyntheticsTestCiOptions(
execution_rule=SyntheticsTestExecutionRule.SKIPPED,
),
ignore_server_certificate_error=True,
disable_csp=True,
initial_navigation_timeout=200,
),
tags=[
"testing:browser",
],
type=SyntheticsBrowserTestType.BROWSER,
steps=[
SyntheticsStep(
allow_failure=False,
is_critical=True,
name="Refresh page",
params=dict(),
type=SyntheticsStepType.REFRESH,
),
],
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
api_instance = SyntheticsApi(api_client)
response = api_instance.create_synthetics_browser_test(body=body)
print(response)
Create a browser test returns "OK - Returns the created test details." response
"""
Create a browser test returns "OK - Returns the created test details." response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.synthetics_api import SyntheticsApi
from datadog_api_client.v1.model.synthetics_browser_test import SyntheticsBrowserTest
from datadog_api_client.v1.model.synthetics_browser_test_config import SyntheticsBrowserTestConfig
from datadog_api_client.v1.model.synthetics_browser_test_type import SyntheticsBrowserTestType
from datadog_api_client.v1.model.synthetics_browser_variable import SyntheticsBrowserVariable
from datadog_api_client.v1.model.synthetics_browser_variable_type import SyntheticsBrowserVariableType
from datadog_api_client.v1.model.synthetics_config_variable import SyntheticsConfigVariable
from datadog_api_client.v1.model.synthetics_config_variable_type import SyntheticsConfigVariableType
from datadog_api_client.v1.model.synthetics_step import SyntheticsStep
from datadog_api_client.v1.model.synthetics_step_type import SyntheticsStepType
from datadog_api_client.v1.model.synthetics_test_options import SyntheticsTestOptions
from datadog_api_client.v1.model.synthetics_test_options_retry import SyntheticsTestOptionsRetry
from datadog_api_client.v1.model.synthetics_test_request import SyntheticsTestRequest
body = SyntheticsBrowserTest(
config=SyntheticsBrowserTestConfig(
assertions=[],
variables=[
SyntheticsBrowserVariable(
type=SyntheticsBrowserVariableType.TEXT,
name="TEST_VARIABLE",
pattern="secret",
secure=True,
example="secret",
),
],
config_variables=[
SyntheticsConfigVariable(
example="content-type",
name="PROPERTY",
pattern="content-type",
type=SyntheticsConfigVariableType.TEXT,
secure=True,
),
],
request=SyntheticsTestRequest(
method="GET",
url="https://datadoghq.com",
),
set_cookie="name:test",
),
locations=[
"aws:us-east-2",
],
message="Test message",
name="Example-Synthetic",
options=SyntheticsTestOptions(
accept_self_signed=False,
allow_insecure=True,
device_ids=[
"chrome.laptop_large",
],
disable_cors=True,
follow_redirects=True,
min_failure_duration=10,
min_location_failed=1,
no_screenshot=True,
retry=SyntheticsTestOptionsRetry(
count=2,
interval=10.0,
),
tick_every=300,
enable_profiling=True,
enable_security_testing=True,
),
tags=[
"testing:browser",
],
type=SyntheticsBrowserTestType.BROWSER,
steps=[
SyntheticsStep(
allow_failure=False,
always_execute=True,
exit_if_succeed=True,
is_critical=True,
name="Refresh page",
params=dict(),
type=SyntheticsStepType.REFRESH,
),
],
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
api_instance = SyntheticsApi(api_client)
response = api_instance.create_synthetics_browser_test(body=body)
print(response)
Create a browser test with advanced scheduling options returns "OK - Returns the created test details." response
"""
Create a browser test with advanced scheduling options returns "OK - Returns the created test details." response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.synthetics_api import SyntheticsApi
from datadog_api_client.v1.model.synthetics_browser_test import SyntheticsBrowserTest
from datadog_api_client.v1.model.synthetics_browser_test_config import SyntheticsBrowserTestConfig
from datadog_api_client.v1.model.synthetics_browser_test_type import SyntheticsBrowserTestType
from datadog_api_client.v1.model.synthetics_config_variable import SyntheticsConfigVariable
from datadog_api_client.v1.model.synthetics_config_variable_type import SyntheticsConfigVariableType
from datadog_api_client.v1.model.synthetics_step import SyntheticsStep
from datadog_api_client.v1.model.synthetics_step_type import SyntheticsStepType
from datadog_api_client.v1.model.synthetics_test_options import SyntheticsTestOptions
from datadog_api_client.v1.model.synthetics_test_options_retry import SyntheticsTestOptionsRetry
from datadog_api_client.v1.model.synthetics_test_options_scheduling import SyntheticsTestOptionsScheduling
from datadog_api_client.v1.model.synthetics_test_options_scheduling_timeframe import (
SyntheticsTestOptionsSchedulingTimeframe,
)
from datadog_api_client.v1.model.synthetics_test_request import SyntheticsTestRequest
body = SyntheticsBrowserTest(
config=SyntheticsBrowserTestConfig(
assertions=[],
config_variables=[
SyntheticsConfigVariable(
example="content-type",
name="PROPERTY",
pattern="content-type",
type=SyntheticsConfigVariableType.TEXT,
),
],
request=SyntheticsTestRequest(
method="GET",
url="https://datadoghq.com",
),
set_cookie="name:test",
),
locations=[
"aws:us-east-2",
],
message="Test message",
name="Example-Synthetic",
options=SyntheticsTestOptions(
accept_self_signed=False,
allow_insecure=True,
device_ids=[
"tablet",
],
disable_cors=True,
follow_redirects=True,
min_failure_duration=10,
min_location_failed=1,
no_screenshot=True,
retry=SyntheticsTestOptionsRetry(
count=2,
interval=10.0,
),
tick_every=300,
scheduling=SyntheticsTestOptionsScheduling(
timeframes=[
SyntheticsTestOptionsSchedulingTimeframe(
day=1,
_from="07:00",
to="16:00",
),
SyntheticsTestOptionsSchedulingTimeframe(
day=3,
_from="07:00",
to="16:00",
),
],
timezone="America/New_York",
),
),
tags=[
"testing:browser",
],
type=SyntheticsBrowserTestType.BROWSER,
steps=[
SyntheticsStep(
allow_failure=False,
is_critical=True,
name="Refresh page",
params=dict(),
type=SyntheticsStepType.REFRESH,
),
],
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
api_instance = SyntheticsApi(api_client)
response = api_instance.create_synthetics_browser_test(body=body)
print(response)
Instructions
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"Create a browser test returns "OK - Returns saved rumSettings." response
# Create a browser test returns "OK - Returns saved rumSettings." response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V1::SyntheticsAPI.new
body = DatadogAPIClient::V1::SyntheticsBrowserTest.new({
config: DatadogAPIClient::V1::SyntheticsBrowserTestConfig.new({
assertions: [],
config_variables: [
DatadogAPIClient::V1::SyntheticsConfigVariable.new({
example: "content-type",
name: "PROPERTY",
pattern: "content-type",
type: DatadogAPIClient::V1::SyntheticsConfigVariableType::TEXT,
}),
],
request: DatadogAPIClient::V1::SyntheticsTestRequest.new({
method: "GET",
url: "https://datadoghq.com",
certificate_domains: [
"https://datadoghq.com",
],
}),
set_cookie: "name:test",
}),
locations: [
"aws:us-east-2",
],
message: "Test message",
name: "Example-Synthetic",
options: DatadogAPIClient::V1::SyntheticsTestOptions.new({
accept_self_signed: false,
allow_insecure: true,
device_ids: [
"tablet",
],
disable_cors: true,
follow_redirects: true,
min_failure_duration: 10,
min_location_failed: 1,
no_screenshot: true,
_retry: DatadogAPIClient::V1::SyntheticsTestOptionsRetry.new({
count: 2,
interval: 10,
}),
rum_settings: DatadogAPIClient::V1::SyntheticsBrowserTestRumSettings.new({
is_enabled: true,
application_id: "mockApplicationId",
client_token_id: 12345,
}),
tick_every: 300,
ci: DatadogAPIClient::V1::SyntheticsTestCiOptions.new({
execution_rule: DatadogAPIClient::V1::SyntheticsTestExecutionRule::SKIPPED,
}),
ignore_server_certificate_error: true,
disable_csp: true,
initial_navigation_timeout: 200,
}),
tags: [
"testing:browser",
],
type: DatadogAPIClient::V1::SyntheticsBrowserTestType::BROWSER,
steps: [
DatadogAPIClient::V1::SyntheticsStep.new({
allow_failure: false,
is_critical: true,
name: "Refresh page",
params: {},
type: DatadogAPIClient::V1::SyntheticsStepType::REFRESH,
}),
],
})
p api_instance.create_synthetics_browser_test(body)
Create a browser test returns "OK - Returns the created test details." response
# Create a browser test returns "OK - Returns the created test details." response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V1::SyntheticsAPI.new
body = DatadogAPIClient::V1::SyntheticsBrowserTest.new({
config: DatadogAPIClient::V1::SyntheticsBrowserTestConfig.new({
assertions: [],
variables: [
DatadogAPIClient::V1::SyntheticsBrowserVariable.new({
type: DatadogAPIClient::V1::SyntheticsBrowserVariableType::TEXT,
name: "TEST_VARIABLE",
pattern: "secret",
secure: true,
example: "secret",
}),
],
config_variables: [
DatadogAPIClient::V1::SyntheticsConfigVariable.new({
example: "content-type",
name: "PROPERTY",
pattern: "content-type",
type: DatadogAPIClient::V1::SyntheticsConfigVariableType::TEXT,
secure: true,
}),
],
request: DatadogAPIClient::V1::SyntheticsTestRequest.new({
method: "GET",
url: "https://datadoghq.com",
}),
set_cookie: "name:test",
}),
locations: [
"aws:us-east-2",
],
message: "Test message",
name: "Example-Synthetic",
options: DatadogAPIClient::V1::SyntheticsTestOptions.new({
accept_self_signed: false,
allow_insecure: true,
device_ids: [
"chrome.laptop_large",
],
disable_cors: true,
follow_redirects: true,
min_failure_duration: 10,
min_location_failed: 1,
no_screenshot: true,
_retry: DatadogAPIClient::V1::SyntheticsTestOptionsRetry.new({
count: 2,
interval: 10,
}),
tick_every: 300,
enable_profiling: true,
enable_security_testing: true,
}),
tags: [
"testing:browser",
],
type: DatadogAPIClient::V1::SyntheticsBrowserTestType::BROWSER,
steps: [
DatadogAPIClient::V1::SyntheticsStep.new({
allow_failure: false,
always_execute: true,
exit_if_succeed: true,
is_critical: true,
name: "Refresh page",
params: {},
type: DatadogAPIClient::V1::SyntheticsStepType::REFRESH,
}),
],
})
p api_instance.create_synthetics_browser_test(body)
Create a browser test with advanced scheduling options returns "OK - Returns the created test details." response
# Create a browser test with advanced scheduling options returns "OK - Returns the created test details." response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V1::SyntheticsAPI.new
body = DatadogAPIClient::V1::SyntheticsBrowserTest.new({
config: DatadogAPIClient::V1::SyntheticsBrowserTestConfig.new({
assertions: [],
config_variables: [
DatadogAPIClient::V1::SyntheticsConfigVariable.new({
example: "content-type",
name: "PROPERTY",
pattern: "content-type",
type: DatadogAPIClient::V1::SyntheticsConfigVariableType::TEXT,
}),
],
request: DatadogAPIClient::V1::SyntheticsTestRequest.new({
method: "GET",
url: "https://datadoghq.com",
}),
set_cookie: "name:test",
}),
locations: [
"aws:us-east-2",
],
message: "Test message",
name: "Example-Synthetic",
options: DatadogAPIClient::V1::SyntheticsTestOptions.new({
accept_self_signed: false,
allow_insecure: true,
device_ids: [
"tablet",
],
disable_cors: true,
follow_redirects: true,
min_failure_duration: 10,
min_location_failed: 1,
no_screenshot: true,
_retry: DatadogAPIClient::V1::SyntheticsTestOptionsRetry.new({
count: 2,
interval: 10,
}),
tick_every: 300,
scheduling: DatadogAPIClient::V1::SyntheticsTestOptionsScheduling.new({
timeframes: [
DatadogAPIClient::V1::SyntheticsTestOptionsSchedulingTimeframe.new({
day: 1,
from: "07:00",
to: "16:00",
}),
DatadogAPIClient::V1::SyntheticsTestOptionsSchedulingTimeframe.new({
day: 3,
from: "07:00",
to: "16:00",
}),
],
timezone: "America/New_York",
}),
}),
tags: [
"testing:browser",
],
type: DatadogAPIClient::V1::SyntheticsBrowserTestType::BROWSER,
steps: [
DatadogAPIClient::V1::SyntheticsStep.new({
allow_failure: false,
is_critical: true,
name: "Refresh page",
params: {},
type: DatadogAPIClient::V1::SyntheticsStepType::REFRESH,
}),
],
})
p api_instance.create_synthetics_browser_test(body)
Instructions
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"Create a browser test returns "OK - Returns saved rumSettings." response
// Create a browser test returns "OK - Returns saved rumSettings." response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_synthetics::SyntheticsAPI;
use datadog_api_client::datadogV1::model::SyntheticsBrowserTest;
use datadog_api_client::datadogV1::model::SyntheticsBrowserTestConfig;
use datadog_api_client::datadogV1::model::SyntheticsBrowserTestRumSettings;
use datadog_api_client::datadogV1::model::SyntheticsBrowserTestType;
use datadog_api_client::datadogV1::model::SyntheticsConfigVariable;
use datadog_api_client::datadogV1::model::SyntheticsConfigVariableType;
use datadog_api_client::datadogV1::model::SyntheticsStep;
use datadog_api_client::datadogV1::model::SyntheticsStepType;
use datadog_api_client::datadogV1::model::SyntheticsTestCiOptions;
use datadog_api_client::datadogV1::model::SyntheticsTestExecutionRule;
use datadog_api_client::datadogV1::model::SyntheticsTestOptions;
use datadog_api_client::datadogV1::model::SyntheticsTestOptionsRetry;
use datadog_api_client::datadogV1::model::SyntheticsTestRequest;
use std::collections::BTreeMap;
#[tokio::main]
async fn main() {
let body = SyntheticsBrowserTest::new(
SyntheticsBrowserTestConfig::new(
vec![],
SyntheticsTestRequest::new()
.certificate_domains(vec!["https://datadoghq.com".to_string()])
.method("GET".to_string())
.url("https://datadoghq.com".to_string()),
)
.config_variables(vec![SyntheticsConfigVariable::new(
"PROPERTY".to_string(),
SyntheticsConfigVariableType::TEXT,
)
.example("content-type".to_string())
.pattern("content-type".to_string())])
.set_cookie("name:test".to_string()),
vec!["aws:us-east-2".to_string()],
"Test message".to_string(),
"Example-Synthetic".to_string(),
SyntheticsTestOptions::new()
.accept_self_signed(false)
.allow_insecure(true)
.ci(SyntheticsTestCiOptions::new(
SyntheticsTestExecutionRule::SKIPPED,
))
.device_ids(vec!["tablet".to_string()])
.disable_cors(true)
.disable_csp(true)
.follow_redirects(true)
.ignore_server_certificate_error(true)
.initial_navigation_timeout(200)
.min_failure_duration(10)
.min_location_failed(1)
.no_screenshot(true)
.retry(
SyntheticsTestOptionsRetry::new()
.count(2)
.interval(10.0 as f64),
)
.rum_settings(
SyntheticsBrowserTestRumSettings::new(true)
.application_id("mockApplicationId".to_string())
.client_token_id(12345),
)
.tick_every(300),
SyntheticsBrowserTestType::BROWSER,
)
.steps(vec![SyntheticsStep::new()
.allow_failure(false)
.is_critical(true)
.name("Refresh page".to_string())
.params(BTreeMap::new())
.type_(SyntheticsStepType::REFRESH)])
.tags(vec!["testing:browser".to_string()]);
let configuration = datadog::Configuration::new();
let api = SyntheticsAPI::with_config(configuration);
let resp = api.create_synthetics_browser_test(body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
Create a browser test returns "OK - Returns the created test details." response
// Create a browser test returns "OK - Returns the created test details." response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_synthetics::SyntheticsAPI;
use datadog_api_client::datadogV1::model::SyntheticsBrowserTest;
use datadog_api_client::datadogV1::model::SyntheticsBrowserTestConfig;
use datadog_api_client::datadogV1::model::SyntheticsBrowserTestType;
use datadog_api_client::datadogV1::model::SyntheticsBrowserVariable;
use datadog_api_client::datadogV1::model::SyntheticsBrowserVariableType;
use datadog_api_client::datadogV1::model::SyntheticsConfigVariable;
use datadog_api_client::datadogV1::model::SyntheticsConfigVariableType;
use datadog_api_client::datadogV1::model::SyntheticsStep;
use datadog_api_client::datadogV1::model::SyntheticsStepType;
use datadog_api_client::datadogV1::model::SyntheticsTestOptions;
use datadog_api_client::datadogV1::model::SyntheticsTestOptionsRetry;
use datadog_api_client::datadogV1::model::SyntheticsTestRequest;
use std::collections::BTreeMap;
#[tokio::main]
async fn main() {
let body = SyntheticsBrowserTest::new(
SyntheticsBrowserTestConfig::new(
vec![],
SyntheticsTestRequest::new()
.method("GET".to_string())
.url("https://datadoghq.com".to_string()),
)
.config_variables(vec![SyntheticsConfigVariable::new(
"PROPERTY".to_string(),
SyntheticsConfigVariableType::TEXT,
)
.example("content-type".to_string())
.pattern("content-type".to_string())
.secure(true)])
.set_cookie("name:test".to_string())
.variables(vec![SyntheticsBrowserVariable::new(
"TEST_VARIABLE".to_string(),
SyntheticsBrowserVariableType::TEXT,
)
.example("secret".to_string())
.pattern("secret".to_string())
.secure(true)]),
vec!["aws:us-east-2".to_string()],
"Test message".to_string(),
"Example-Synthetic".to_string(),
SyntheticsTestOptions::new()
.accept_self_signed(false)
.allow_insecure(true)
.device_ids(vec!["chrome.laptop_large".to_string()])
.disable_cors(true)
.enable_profiling(true)
.enable_security_testing(true)
.follow_redirects(true)
.min_failure_duration(10)
.min_location_failed(1)
.no_screenshot(true)
.retry(
SyntheticsTestOptionsRetry::new()
.count(2)
.interval(10.0 as f64),
)
.tick_every(300),
SyntheticsBrowserTestType::BROWSER,
)
.steps(vec![SyntheticsStep::new()
.allow_failure(false)
.always_execute(true)
.exit_if_succeed(true)
.is_critical(true)
.name("Refresh page".to_string())
.params(BTreeMap::new())
.type_(SyntheticsStepType::REFRESH)])
.tags(vec!["testing:browser".to_string()]);
let configuration = datadog::Configuration::new();
let api = SyntheticsAPI::with_config(configuration);
let resp = api.create_synthetics_browser_test(body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
Create a browser test with advanced scheduling options returns "OK - Returns the created test details." response
// Create a browser test with advanced scheduling options returns "OK - Returns
// the created test details." response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_synthetics::SyntheticsAPI;
use datadog_api_client::datadogV1::model::SyntheticsBrowserTest;
use datadog_api_client::datadogV1::model::SyntheticsBrowserTestConfig;
use datadog_api_client::datadogV1::model::SyntheticsBrowserTestType;
use datadog_api_client::datadogV1::model::SyntheticsConfigVariable;
use datadog_api_client::datadogV1::model::SyntheticsConfigVariableType;
use datadog_api_client::datadogV1::model::SyntheticsStep;
use datadog_api_client::datadogV1::model::SyntheticsStepType;
use datadog_api_client::datadogV1::model::SyntheticsTestOptions;
use datadog_api_client::datadogV1::model::SyntheticsTestOptionsRetry;
use datadog_api_client::datadogV1::model::SyntheticsTestOptionsScheduling;
use datadog_api_client::datadogV1::model::SyntheticsTestOptionsSchedulingTimeframe;
use datadog_api_client::datadogV1::model::SyntheticsTestRequest;
use std::collections::BTreeMap;
#[tokio::main]
async fn main() {
let body = SyntheticsBrowserTest::new(
SyntheticsBrowserTestConfig::new(
vec![],
SyntheticsTestRequest::new()
.method("GET".to_string())
.url("https://datadoghq.com".to_string()),
)
.config_variables(vec![SyntheticsConfigVariable::new(
"PROPERTY".to_string(),
SyntheticsConfigVariableType::TEXT,
)
.example("content-type".to_string())
.pattern("content-type".to_string())])
.set_cookie("name:test".to_string()),
vec!["aws:us-east-2".to_string()],
"Test message".to_string(),
"Example-Synthetic".to_string(),
SyntheticsTestOptions::new()
.accept_self_signed(false)
.allow_insecure(true)
.device_ids(vec!["tablet".to_string()])
.disable_cors(true)
.follow_redirects(true)
.min_failure_duration(10)
.min_location_failed(1)
.no_screenshot(true)
.retry(
SyntheticsTestOptionsRetry::new()
.count(2)
.interval(10.0 as f64),
)
.scheduling(SyntheticsTestOptionsScheduling::new(
vec![
SyntheticsTestOptionsSchedulingTimeframe::new(
1,
"07:00".to_string(),
"16:00".to_string(),
),
SyntheticsTestOptionsSchedulingTimeframe::new(
3,
"07:00".to_string(),
"16:00".to_string(),
),
],
"America/New_York".to_string(),
))
.tick_every(300),
SyntheticsBrowserTestType::BROWSER,
)
.steps(vec![SyntheticsStep::new()
.allow_failure(false)
.is_critical(true)
.name("Refresh page".to_string())
.params(BTreeMap::new())
.type_(SyntheticsStepType::REFRESH)])
.tags(vec!["testing:browser".to_string()]);
let configuration = datadog::Configuration::new();
let api = SyntheticsAPI::with_config(configuration);
let resp = api.create_synthetics_browser_test(body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
Instructions
First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runCreate a browser test returns "OK - Returns saved rumSettings." response
/**
* Create a browser test returns "OK - Returns saved rumSettings." response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration({
authMethods: {
AuthZ: {
accessToken: process.env.DD_BEARER_TOKEN as string,
},
},
});
const apiInstance = new v1.SyntheticsApi(configuration);
const params: v1.SyntheticsApiCreateSyntheticsBrowserTestRequest = {
body: {
config: {
assertions: [],
configVariables: [
{
example: "content-type",
name: "PROPERTY",
pattern: "content-type",
type: "text",
},
],
request: {
method: "GET",
url: "https://datadoghq.com",
certificateDomains: ["https://datadoghq.com"],
},
setCookie: "name:test",
},
locations: ["aws:us-east-2"],
message: "Test message",
name: "Example-Synthetic",
options: {
acceptSelfSigned: false,
allowInsecure: true,
deviceIds: ["tablet"],
disableCors: true,
followRedirects: true,
minFailureDuration: 10,
minLocationFailed: 1,
noScreenshot: true,
retry: {
count: 2,
interval: 10,
},
rumSettings: {
isEnabled: true,
applicationId: "mockApplicationId",
clientTokenId: 12345,
},
tickEvery: 300,
ci: {
executionRule: "skipped",
},
ignoreServerCertificateError: true,
disableCsp: true,
initialNavigationTimeout: 200,
},
tags: ["testing:browser"],
type: "browser",
steps: [
{
allowFailure: false,
isCritical: true,
name: "Refresh page",
params: {},
type: "refresh",
},
],
},
};
apiInstance
.createSyntheticsBrowserTest(params)
.then((data: v1.SyntheticsBrowserTest) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
Create a browser test returns "OK - Returns the created test details." response
/**
* Create a browser test returns "OK - Returns the created test details." response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration({
authMethods: {
AuthZ: {
accessToken: process.env.DD_BEARER_TOKEN as string,
},
},
});
const apiInstance = new v1.SyntheticsApi(configuration);
const params: v1.SyntheticsApiCreateSyntheticsBrowserTestRequest = {
body: {
config: {
assertions: [],
variables: [
{
type: "text",
name: "TEST_VARIABLE",
pattern: "secret",
secure: true,
example: "secret",
},
],
configVariables: [
{
example: "content-type",
name: "PROPERTY",
pattern: "content-type",
type: "text",
secure: true,
},
],
request: {
method: "GET",
url: "https://datadoghq.com",
},
setCookie: "name:test",
},
locations: ["aws:us-east-2"],
message: "Test message",
name: "Example-Synthetic",
options: {
acceptSelfSigned: false,
allowInsecure: true,
deviceIds: ["chrome.laptop_large"],
disableCors: true,
followRedirects: true,
minFailureDuration: 10,
minLocationFailed: 1,
noScreenshot: true,
retry: {
count: 2,
interval: 10,
},
tickEvery: 300,
enableProfiling: true,
enableSecurityTesting: true,
},
tags: ["testing:browser"],
type: "browser",
steps: [
{
allowFailure: false,
alwaysExecute: true,
exitIfSucceed: true,
isCritical: true,
name: "Refresh page",
params: {},
type: "refresh",
},
],
},
};
apiInstance
.createSyntheticsBrowserTest(params)
.then((data: v1.SyntheticsBrowserTest) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
Create a browser test with advanced scheduling options returns "OK - Returns the created test details." response
/**
* Create a browser test with advanced scheduling options returns "OK - Returns the created test details." response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration({
authMethods: {
AuthZ: {
accessToken: process.env.DD_BEARER_TOKEN as string,
},
},
});
const apiInstance = new v1.SyntheticsApi(configuration);
const params: v1.SyntheticsApiCreateSyntheticsBrowserTestRequest = {
body: {
config: {
assertions: [],
configVariables: [
{
example: "content-type",
name: "PROPERTY",
pattern: "content-type",
type: "text",
},
],
request: {
method: "GET",
url: "https://datadoghq.com",
},
setCookie: "name:test",
},
locations: ["aws:us-east-2"],
message: "Test message",
name: "Example-Synthetic",
options: {
acceptSelfSigned: false,
allowInsecure: true,
deviceIds: ["tablet"],
disableCors: true,
followRedirects: true,
minFailureDuration: 10,
minLocationFailed: 1,
noScreenshot: true,
retry: {
count: 2,
interval: 10,
},
tickEvery: 300,
scheduling: {
timeframes: [
{
day: 1,
from: "07:00",
to: "16:00",
},
{
day: 3,
from: "07:00",
to: "16:00",
},
],
timezone: "America/New_York",
},
},
tags: ["testing:browser"],
type: "browser",
steps: [
{
allowFailure: false,
isCritical: true,
name: "Refresh page",
params: {},
type: "refresh",
},
],
},
};
apiInstance
.createSyntheticsBrowserTest(params)
.then((data: v1.SyntheticsBrowserTest) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
Instructions
First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"