Class SyntheticsTestOptions

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

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Allows loading insecure content for an HTTP request in an API test.

Array of URL patterns to block.

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

CI/CD options for a Synthetic test.

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

For SSL tests, whether or not the test should disable fetching intermediate certificates from AIA.

Whether or not to disable CORS mechanism.

Disable Content Security Policy for browser tests.

Enable profiling for browser tests.

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

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

HTTP version to use for a Synthetic test.

Ignore server certificate error for browser tests.

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

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

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

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

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

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

Prevents saving screenshots of the steps.

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.

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

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.

Object containing timeframes and timezone used for advanced scheduling.

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