TestTest is the Schema for the Tests API. Provides a Datadog synthetics test resource. This can be used to create and manage Datadog synthetics test.
TypeMR
Providerprovider-datadog
Groupsynthetics.datadog.upbound.io
Scopecluster
Versionv1alpha1

1apiVersion: synthetics.datadog.upbound.io/v1alpha1

2kind: Test

kind
string
metadata
object
spec
object

TestSpec defines the desired state of Test

forProvider
required
object

(No description available)

apiStep
array

(Block List) Steps for multistep api tests (see below for nested schema) Steps for multistep api tests

array

(Block List) Assertions used for the test. Multiple assertion blocks are allowed with the structure below. (see below for nested schema) Assertions used for the test. Multiple assertion blocks are allowed with the structure below.

operator
string
property
string
target
string
array

(Block List, Max: 1) Expected structure if operator is validatesJSONPath. Exactly one nested block is allowed with the structure below. (see below for nested schema) Expected structure if operator is validatesJSONPath. Exactly one nested block is allowed with the structure below.

jsonpath
string
operator
string
array

(Block List, Max: 1) Expected structure if operator is validatesXPath. Exactly one nested block is allowed with the structure below. (see below for nested schema) Expected structure if operator is validatesXPath. Exactly one nested block is allowed with the structure below.

operator
string
xpath
string
type
string
array

(Block List) Values to parse and save as variables from the response. (see below for nested schema) Values to parse and save as variables from the response.

field
string
name
string
parser
array

(Block List, Min: 1, Max: 1) (see below for nested schema)

type
string
value
string
secure
boolean
type
string
isCritical
boolean
name
string
array

(Block List, Max: 1) The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below. (see below for nested schema) The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.

object

(String, Sensitive) Access key for SIGV4 authentication. Access key for SIGV4 authentication.

key
required
string
name
required
string
namespace
required
string
audience
string
clientId
string
object

client or oauth-rop authentication. Client secret for oauth-client or oauth-rop authentication.

key
required
string
name
required
string
namespace
required
string
domain
string
object

(String, Sensitive) Password for authentication. Password for authentication.

key
required
string
name
required
string
namespace
required
string
region
string
resource
string
scope
string
object

(String, Sensitive) Secret key for SIGV4 authentication. Secret key for SIGV4 authentication.

key
required
string
name
required
string
namespace
required
string
type
string
username
string
array

(Block List, Max: 1) Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below. (see below for nested schema) Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.

cert
array

(Block List, Min: 1, Max: 1) (see below for nested schema)

contentSecretRef
required
object

(String, Sensitive) Content of the certificate. Content of the certificate.

key
required
string
name
required
string
namespace
required
string
filename
string
key
array

(Block List, Min: 1, Max: 1) (see below for nested schema)

contentSecretRef
required
object

(String, Sensitive) Content of the certificate. Content of the certificate.

key
required
string
name
required
string
namespace
required
string
filename
string
array

(Block List, Max: 1) Required if type = "api". The synthetics test request. (see below for nested schema) The request for the api step.

body
string
bodyType
string
callType
string
array

(List of 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 certificate_domains. 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 certificate_domains.

dnsServer
string
host
string
message
string
method
string
port
number
service
string
timeout
number
url
string
array

(Block List, Max: 1) The proxy to perform the test. (see below for nested schema) The proxy to perform the test.

headers
object
url
string
retry
array

(Block List, Max: 1) (see below for nested schema)

count
number
interval
number
subtype
string
array

(Block List) Assertions used for the test. Multiple assertion blocks are allowed with the structure below. (see below for nested schema) Assertions used for the test. Multiple assertion blocks are allowed with the structure below.

operator
string
property
string
target
string
array

(Block List, Max: 1) Expected structure if operator is validatesJSONPath. Exactly one nested block is allowed with the structure below. (see below for nested schema) Expected structure if operator is validatesJSONPath. Exactly one nested block is allowed with the structure below.

jsonpath
string
operator
string
array

(Block List, Max: 1) Expected structure if operator is validatesXPath. Exactly one nested block is allowed with the structure below. (see below for nested schema) Expected structure if operator is validatesXPath. Exactly one nested block is allowed with the structure below.

operator
string
xpath
string
type
string
array

(Block List) Steps for browser tests. (see below for nested schema) Steps for browser tests.

isCritical
boolean
name
string
params
array

(Block List, Min: 1, Max: 1) Parameters for the step. (see below for nested schema) Parameters for the step.

attribute
string
check
string
clickType
string
code
string
delay
number
element
string
array

(Block List, Max: 1) Custom user selector to use for the step. (see below for nested schema) Custom user selector to use for the step.

value
array

(String) Regex or JSON path used for the parser. Not used with type raw.

type
string
value
string
email
string
file
string
files
string
array

(List of String) Modifier to use for a "press key" step. Modifier to use for a "press key" step.

request
string
value
string
array

(Block List, Max: 1) Details of the variable to extract. (see below for nested schema) Details of the variable to extract.

example
string
name
string
withClick
boolean
x
number
y
number
timeout
number
type
string
array

(Block List) Variables used for a browser test steps. Multiple variable blocks are allowed with the structure below. (see below for nested schema) Variables used for a browser test steps. Multiple variable blocks are allowed with the structure below.

example
string
id
string
name
string
pattern
string
secure
boolean
type
string
array

(Block List) Variables used for the test configuration. Multiple config_variable blocks are allowed with the structure below. (see below for nested schema) Variables used for the test configuration. Multiple config_variable blocks are allowed with the structure below.

example
string
id
string
name
string
pattern
string
secure
boolean
type
string
array

(List of String) Required if type = "browser". Array with the different device IDs used to run the test. Valid values are laptop_large, tablet, mobile_small, chrome.laptop_large, chrome.tablet, chrome.mobile_small, firefox.laptop_large, firefox.tablet, firefox.mobile_small, edge.laptop_large, edge.tablet, edge.mobile_small. Required if type = "browser". Array with the different device IDs used to run the test. Valid values are laptop_large, tablet, mobile_small, chrome.laptop_large, chrome.tablet, chrome.mobile_small, firefox.laptop_large, firefox.tablet, firefox.mobile_small, edge.laptop_large, edge.tablet, edge.mobile_small.

array

(Set of String) Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations. Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.

message
string
name
string
array

(Block List, Max: 1) (see below for nested schema)

ci
array

(Block List, Max: 1) CI/CD options for a Synthetic test. (see below for nested schema) CI/CD options for a Synthetic test.

disableCsp
boolean
array

(Block List, Max: 1) (see below for nested schema)

array

(Set of String) A list of role identifiers pulled from the Roles API to restrict read and write access. A list of role identifiers pulled from the Roles API to restrict read and write access.

retry
array

(Block List, Max: 1) (see below for nested schema)

count
number
interval
number
array

(Block List, Max: 1) The RUM data collection settings for the Synthetic browser test. (see below for nested schema) The RUM data collection settings for the Synthetic browser test.

array

(Block List, Max: 1) Object containing timeframes and timezone used for advanced scheduling. (see below for nested schema) Object containing timeframes and timezone used for advanced scheduling.

array

(Block Set, Min: 1) Array containing objects describing the scheduling pattern to apply to each day. (see below for nested schema) Array containing objects describing the scheduling pattern to apply to each day.

day
number
from
string
to
string
timezone
string
tickEvery
number
array

(Block List, Max: 1) The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below. (see below for nested schema) The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.

object

(String, Sensitive) Access key for SIGV4 authentication. Access key for SIGV4 authentication.

key
required
string
name
required
string
namespace
required
string
audience
string
clientId
string
object

client or oauth-rop authentication. Client secret for oauth-client or oauth-rop authentication.

key
required
string
name
required
string
namespace
required
string
domain
string
object

(String, Sensitive) Password for authentication. Password for authentication.

key
required
string
name
required
string
namespace
required
string
region
string
resource
string
scope
string
object

(String, Sensitive) Secret key for SIGV4 authentication. Secret key for SIGV4 authentication.

key
required
string
name
required
string
namespace
required
string
type
string
username
string
array

(Block List, Max: 1) Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below. (see below for nested schema) Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.

cert
array

(Block List, Min: 1, Max: 1) (see below for nested schema)

contentSecretRef
required
object

(String, Sensitive) Content of the certificate. Content of the certificate.

key
required
string
name
required
string
namespace
required
string
filename
string
key
array

(Block List, Min: 1, Max: 1) (see below for nested schema)

contentSecretRef
required
object

(String, Sensitive) Content of the certificate. Content of the certificate.

key
required
string
name
required
string
namespace
required
string
filename
string
array

(Block List, Max: 1) Required if type = "api". The synthetics test request. (see below for nested schema) Required if type = "api". The synthetics test request.

body
string
bodyType
string
callType
string
array

(List of 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 certificate_domains. 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 certificate_domains.

dnsServer
string
host
string
message
string
method
string
port
number
service
string
timeout
number
url
string
array

(Block List, Max: 1) The proxy to perform the test. (see below for nested schema) The proxy to perform the test.

headers
object
url
string
setCookie
string
status
string
subtype
string
tags
array

(List of String) A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list ([]). A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list ([]).

type
string
object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

apiStep
array

(Block List) Steps for multistep api tests (see below for nested schema) Steps for multistep api tests

array

(Block List) Assertions used for the test. Multiple assertion blocks are allowed with the structure below. (see below for nested schema) Assertions used for the test. Multiple assertion blocks are allowed with the structure below.

operator
string
property
string
target
string
array

(Block List, Max: 1) Expected structure if operator is validatesJSONPath. Exactly one nested block is allowed with the structure below. (see below for nested schema) Expected structure if operator is validatesJSONPath. Exactly one nested block is allowed with the structure below.

jsonpath
string
operator
string
array

(Block List, Max: 1) Expected structure if operator is validatesXPath. Exactly one nested block is allowed with the structure below. (see below for nested schema) Expected structure if operator is validatesXPath. Exactly one nested block is allowed with the structure below.

operator
string
xpath
string
type
string
array

(Block List) Values to parse and save as variables from the response. (see below for nested schema) Values to parse and save as variables from the response.

field
string
name
string
parser
array

(Block List, Min: 1, Max: 1) (see below for nested schema)

type
string
value
string
secure
boolean
type
string
isCritical
boolean
name
string
array

(Block List, Max: 1) The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below. (see below for nested schema) The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.

array

(Block List, Max: 1) Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below. (see below for nested schema) Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.

cert
array

(Block List, Min: 1, Max: 1) (see below for nested schema)

filename
string
key
array

(Block List, Min: 1, Max: 1) (see below for nested schema)

filename
string
array

(Block List, Max: 1) Required if type = "api". The synthetics test request. (see below for nested schema) The request for the api step.

body
string
bodyType
string
callType
string
array

(List of 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 certificate_domains. 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 certificate_domains.

dnsServer
string
host
string
message
string
method
string
port
number
service
string
timeout
number
url
string
array

(Block List, Max: 1) The proxy to perform the test. (see below for nested schema) The proxy to perform the test.

headers
object
url
string
retry
array

(Block List, Max: 1) (see below for nested schema)

count
number
interval
number
subtype
string
array

(Block List) Assertions used for the test. Multiple assertion blocks are allowed with the structure below. (see below for nested schema) Assertions used for the test. Multiple assertion blocks are allowed with the structure below.

operator
string
property
string
target
string
array

(Block List, Max: 1) Expected structure if operator is validatesJSONPath. Exactly one nested block is allowed with the structure below. (see below for nested schema) Expected structure if operator is validatesJSONPath. Exactly one nested block is allowed with the structure below.

jsonpath
string
operator
string
array

(Block List, Max: 1) Expected structure if operator is validatesXPath. Exactly one nested block is allowed with the structure below. (see below for nested schema) Expected structure if operator is validatesXPath. Exactly one nested block is allowed with the structure below.

operator
string
xpath
string
type
string
array

(Block List) Steps for browser tests. (see below for nested schema) Steps for browser tests.

isCritical
boolean
name
string
params
array

(Block List, Min: 1, Max: 1) Parameters for the step. (see below for nested schema) Parameters for the step.

attribute
string
check
string
clickType
string
code
string
delay
number
element
string
array

(Block List, Max: 1) Custom user selector to use for the step. (see below for nested schema) Custom user selector to use for the step.

value
array

(String) Regex or JSON path used for the parser. Not used with type raw.

type
string
value
string
email
string
file
string
files
string
array

(List of String) Modifier to use for a "press key" step. Modifier to use for a "press key" step.

request
string
value
string
array

(Block List, Max: 1) Details of the variable to extract. (see below for nested schema) Details of the variable to extract.

example
string
name
string
withClick
boolean
x
number
y
number
timeout
number
type
string
array

(Block List) Variables used for a browser test steps. Multiple variable blocks are allowed with the structure below. (see below for nested schema) Variables used for a browser test steps. Multiple variable blocks are allowed with the structure below.

example
string
id
string
name
string
pattern
string
secure
boolean
type
string
array

(Block List) Variables used for the test configuration. Multiple config_variable blocks are allowed with the structure below. (see below for nested schema) Variables used for the test configuration. Multiple config_variable blocks are allowed with the structure below.

example
string
id
string
name
string
pattern
string
secure
boolean
type
string
array

(List of String) Required if type = "browser". Array with the different device IDs used to run the test. Valid values are laptop_large, tablet, mobile_small, chrome.laptop_large, chrome.tablet, chrome.mobile_small, firefox.laptop_large, firefox.tablet, firefox.mobile_small, edge.laptop_large, edge.tablet, edge.mobile_small. Required if type = "browser". Array with the different device IDs used to run the test. Valid values are laptop_large, tablet, mobile_small, chrome.laptop_large, chrome.tablet, chrome.mobile_small, firefox.laptop_large, firefox.tablet, firefox.mobile_small, edge.laptop_large, edge.tablet, edge.mobile_small.

array

(Set of String) Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations. Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.

message
string
name
string
array

(Block List, Max: 1) (see below for nested schema)

ci
array

(Block List, Max: 1) CI/CD options for a Synthetic test. (see below for nested schema) CI/CD options for a Synthetic test.

disableCsp
boolean
array

(Block List, Max: 1) (see below for nested schema)

array

(Set of String) A list of role identifiers pulled from the Roles API to restrict read and write access. A list of role identifiers pulled from the Roles API to restrict read and write access.

retry
array

(Block List, Max: 1) (see below for nested schema)

count
number
interval
number
array

(Block List, Max: 1) The RUM data collection settings for the Synthetic browser test. (see below for nested schema) The RUM data collection settings for the Synthetic browser test.

array

(Block List, Max: 1) Object containing timeframes and timezone used for advanced scheduling. (see below for nested schema) Object containing timeframes and timezone used for advanced scheduling.

array

(Block Set, Min: 1) Array containing objects describing the scheduling pattern to apply to each day. (see below for nested schema) Array containing objects describing the scheduling pattern to apply to each day.

day
number
from
string
to
string
timezone
string
tickEvery
number
array

(Block List, Max: 1) The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below. (see below for nested schema) The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.

array

(Block List, Max: 1) Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below. (see below for nested schema) Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.

cert
array

(Block List, Min: 1, Max: 1) (see below for nested schema)

filename
string
key
array

(Block List, Min: 1, Max: 1) (see below for nested schema)

filename
string
array

(Block List, Max: 1) Required if type = "api". The synthetics test request. (see below for nested schema) Required if type = "api". The synthetics test request.

body
string
bodyType
string
callType
string
array

(List of 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 certificate_domains. 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 certificate_domains.

dnsServer
string
host
string
message
string
method
string
port
number
service
string
timeout
number
url
string
array

(Block List, Max: 1) The proxy to perform the test. (see below for nested schema) The proxy to perform the test.

headers
object
url
string
setCookie
string
status
string
subtype
string
tags
array

(List of String) A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list ([]). A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list ([]).

type
string
array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

name
required
string
policy
object

Policies for referencing.

resolve
string
object

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

configRef
object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name
required
string
policy
object

Policies for referencing.

resolve
string
metadata
object

Metadata is the metadata for connection secret.

labels
object
type
string
name
required
string
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

name
required
string
namespace
required
string
status
object

TestStatus defines the observed state of Test.

object

(No description available)

apiStep
array

(Block List) Steps for multistep api tests (see below for nested schema) Steps for multistep api tests

array

(Block List) Assertions used for the test. Multiple assertion blocks are allowed with the structure below. (see below for nested schema) Assertions used for the test. Multiple assertion blocks are allowed with the structure below.

operator
string
property
string
target
string
array

(Block List, Max: 1) Expected structure if operator is validatesJSONPath. Exactly one nested block is allowed with the structure below. (see below for nested schema) Expected structure if operator is validatesJSONPath. Exactly one nested block is allowed with the structure below.

jsonpath
string
operator
string
array

(Block List, Max: 1) Expected structure if operator is validatesXPath. Exactly one nested block is allowed with the structure below. (see below for nested schema) Expected structure if operator is validatesXPath. Exactly one nested block is allowed with the structure below.

operator
string
xpath
string
type
string
array

(Block List) Values to parse and save as variables from the response. (see below for nested schema) Values to parse and save as variables from the response.

field
string
name
string
parser
array

(Block List, Min: 1, Max: 1) (see below for nested schema)

type
string
value
string
secure
boolean
type
string
isCritical
boolean
name
string
array

(Block List, Max: 1) The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below. (see below for nested schema) The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.

array

(Block List, Max: 1) Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below. (see below for nested schema) Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.

cert
array

(Block List, Min: 1, Max: 1) (see below for nested schema)

filename
string
key
array

(Block List, Min: 1, Max: 1) (see below for nested schema)

filename
string
array

(Block List, Max: 1) Required if type = "api". The synthetics test request. (see below for nested schema) The request for the api step.

body
string
bodyType
string
callType
string
array

(List of 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 certificate_domains. 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 certificate_domains.

dnsServer
string
host
string
message
string
method
string
port
number
service
string
timeout
number
url
string
array

(Block List, Max: 1) The proxy to perform the test. (see below for nested schema) The proxy to perform the test.

headers
object
url
string
retry
array

(Block List, Max: 1) (see below for nested schema)

count
number
interval
number
subtype
string
array

(Block List) Assertions used for the test. Multiple assertion blocks are allowed with the structure below. (see below for nested schema) Assertions used for the test. Multiple assertion blocks are allowed with the structure below.

operator
string
property
string
target
string
array

(Block List, Max: 1) Expected structure if operator is validatesJSONPath. Exactly one nested block is allowed with the structure below. (see below for nested schema) Expected structure if operator is validatesJSONPath. Exactly one nested block is allowed with the structure below.

jsonpath
string
operator
string
array

(Block List, Max: 1) Expected structure if operator is validatesXPath. Exactly one nested block is allowed with the structure below. (see below for nested schema) Expected structure if operator is validatesXPath. Exactly one nested block is allowed with the structure below.

operator
string
xpath
string
type
string
array

(Block List) Steps for browser tests. (see below for nested schema) Steps for browser tests.

isCritical
boolean
name
string
params
array

(Block List, Min: 1, Max: 1) Parameters for the step. (see below for nested schema) Parameters for the step.

attribute
string
check
string
clickType
string
code
string
delay
number
element
string
array

(Block List, Max: 1) Custom user selector to use for the step. (see below for nested schema) Custom user selector to use for the step.

value
array

(String) Regex or JSON path used for the parser. Not used with type raw.

type
string
value
string
email
string
file
string
files
string
array

(List of String) Modifier to use for a "press key" step. Modifier to use for a "press key" step.

request
string
value
string
array

(Block List, Max: 1) Details of the variable to extract. (see below for nested schema) Details of the variable to extract.

example
string
name
string
withClick
boolean
x
number
y
number
timeout
number
type
string
array

(Block List) Variables used for a browser test steps. Multiple variable blocks are allowed with the structure below. (see below for nested schema) Variables used for a browser test steps. Multiple variable blocks are allowed with the structure below.

example
string
id
string
name
string
pattern
string
secure
boolean
type
string
array

(Block List) Variables used for the test configuration. Multiple config_variable blocks are allowed with the structure below. (see below for nested schema) Variables used for the test configuration. Multiple config_variable blocks are allowed with the structure below.

example
string
id
string
name
string
pattern
string
secure
boolean
type
string
array

(List of String) Required if type = "browser". Array with the different device IDs used to run the test. Valid values are laptop_large, tablet, mobile_small, chrome.laptop_large, chrome.tablet, chrome.mobile_small, firefox.laptop_large, firefox.tablet, firefox.mobile_small, edge.laptop_large, edge.tablet, edge.mobile_small. Required if type = "browser". Array with the different device IDs used to run the test. Valid values are laptop_large, tablet, mobile_small, chrome.laptop_large, chrome.tablet, chrome.mobile_small, firefox.laptop_large, firefox.tablet, firefox.mobile_small, edge.laptop_large, edge.tablet, edge.mobile_small.

id
string
array

(Set of String) Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations. Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.

message
string
monitorId
number
name
string
array

(Block List, Max: 1) (see below for nested schema)

ci
array

(Block List, Max: 1) CI/CD options for a Synthetic test. (see below for nested schema) CI/CD options for a Synthetic test.

disableCsp
boolean
array

(Block List, Max: 1) (see below for nested schema)

array

(Set of String) A list of role identifiers pulled from the Roles API to restrict read and write access. A list of role identifiers pulled from the Roles API to restrict read and write access.

retry
array

(Block List, Max: 1) (see below for nested schema)

count
number
interval
number
array

(Block List, Max: 1) The RUM data collection settings for the Synthetic browser test. (see below for nested schema) The RUM data collection settings for the Synthetic browser test.

array

(Block List, Max: 1) Object containing timeframes and timezone used for advanced scheduling. (see below for nested schema) Object containing timeframes and timezone used for advanced scheduling.

array

(Block Set, Min: 1) Array containing objects describing the scheduling pattern to apply to each day. (see below for nested schema) Array containing objects describing the scheduling pattern to apply to each day.

day
number
from
string
to
string
timezone
string
tickEvery
number
array

(Block List, Max: 1) The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below. (see below for nested schema) The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.

array

(Block List, Max: 1) Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below. (see below for nested schema) Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.

cert
array

(Block List, Min: 1, Max: 1) (see below for nested schema)

filename
string
key
array

(Block List, Min: 1, Max: 1) (see below for nested schema)

filename
string
array

(Block List, Max: 1) Required if type = "api". The synthetics test request. (see below for nested schema) Required if type = "api". The synthetics test request.

body
string
bodyType
string
callType
string
array

(List of 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 certificate_domains. 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 certificate_domains.

dnsServer
string
host
string
message
string
method
string
port
number
service
string
timeout
number
url
string
array

(Block List, Max: 1) The proxy to perform the test. (see below for nested schema) The proxy to perform the test.

headers
object
url
string
setCookie
string
status
string
subtype
string
tags
array

(List of String) A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list ([]). A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list ([]).

type
string
array

Conditions of the resource.

lastTransitionTime
required
string
message
string
reason
required
string
status
required
string
type
required
string
Discover the building blocks for your internal cloud platform.
© 2026 Upbound, Inc.
Solutions
Learn
Company
Community
More