Script mode for HTTP monitor configuration
- How-to guide
- 1-min read
- Published Jul 17, 2019
In addition to the configuration in the UI (Visual mode), you can use Script mode to configure your HTTP monitors. In this mode, you can access the underlying JSON script of your monitor. If you're a Synthetic Monitoring power user, this will make your life a lot easier and allow you to speed up monitor creation and management. Use the script editor to quickly find specific events (steps) or adapt locators across the entire script.
You aren't limited to just one mode—you can switch between the UI and script modes by selecting the Visual mode/Script mode.
Access the script
To edit your HTTP monitor in script mode:
- Go to Synthetic Classic and opt to view your monitors in list mode.
- Select the check box next to the monitor that you want to edit > select Edit in the lower-left corner.
- Select the HTTP Requests tab of Monitor settings on the left.
- Select Script mode at the top.
Edit the script
You can download the script (Download script as .json) or just copy it from the editor and edit it in a text editor of your choice. However, you can also edit the script directly in the browser. This provides the following benefits:
- Autocomplete—just press Ctrl+Spacebar to see a list of suggestions.
- Syntax highlighting makes it easier for you to write script code.
- Instant error validation—the editor instantly shows a warning for any error in the script. Hover over the error to see what's wrong and a suggestion for how to fix it. You cannot save changes until the code is error free.
Note that you need to escape all special characters and break lines with a backslash (for example, a new line is \n, double quotes is \", and tab is \t).
Script structure
Main script object
Contains the monitor script.
The request object
Contains the parameters of an HTTP request.
The requestValidation object
Contains the validation configuration for the request.
The following types of rules (see validationRule) are evaluated for HTTP monitor validation:
- Response status code validation
- Text validation, where the response body is checked for a string of text or a regular expression
- SSL certificate expiry validation
This means that the monitor will fail if at least one of these rules with passIfFound = false is met or at least one rule with passIfFound = true is not met.
The monitor will succeed if all rules with passIfFound = false are not met and all rules with passIfFound = true are met.
The validationRule object
Contains a validation rule.
The requestConfiguration object
Contains the setup of the monitor.
The requestHeader object
Contains an HTTP header of the request.
Synthetic Classic