Optional acceptFor SSL test, whether or not the test should allow self signed certificates.
Optional additionalA container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.
Optional allowAllows loading insecure content for an HTTP request in an API test.
Optional checkFor SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
Optional ciCI/CD options for a Synthetic test.
Optional deviceFor browser test, array with the different device IDs used to run the test.
Optional disableWhether or not to disable CORS mechanism.
Optional disableDisable Content Security Policy for browser tests.
Optional enableEnable profiling for browser tests.
Optional enableEnable security testing for browser tests. Security testing is not available anymore. This field is deprecated and won't be used.
Optional followFor API HTTP test, whether or not the test should follow redirects.
Optional httpHTTP version to use for a Synthetic test.
Optional ignoreIgnore server certificate error for browser tests.
Optional initialTimeout before declaring the initial step as failed (in seconds) for browser tests.
Optional minMinimum amount of time in failure required to trigger an alert.
Optional minMinimum number of locations in failure required to trigger an alert.
Optional monitorThe monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
Optional monitorObject containing the options for a Synthetic test as a monitor (for example, renotification).
Optional monitorInteger from 1 (high) to 5 (low) indicating alert severity.
Optional noPrevents saving screenshots of the steps.
Optional restrictedA list of role identifiers that can be pulled from the Roles API, for restricting read and write access.
Optional retryObject describing the retry strategy to apply to a Synthetic test.
Optional rumThe 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.
Optional schedulingObject containing timeframes and timezone used for advanced scheduling.
Optional tickThe frequency at which to run the Synthetic test (in seconds).
Generated using TypeDoc
Object describing the extra options for a Synthetic test.