Transaction Check Syntax for Terraform and Rest API

Transaction checks can be created or edited using the Uptime.com Terraform provider or the REST API.

Below you may find a list of the Commands and Validators as well as their required format for your Terraform and API usage.

Commands:  

Authentication & Settings:
{"step_def":"C_AUTH_AND_SETTINGS","values":{"username":"","password":"","headers":{},"filter_urls":"","viewport_size":"","is_mobile":"","totp_secret":"","totp_period":30,"totp_digits":6,"no_screenshots":""}},

Go To URL: {"step_def":"C_OPEN_URL","values":{"url":"https://uptime.com"}},

Click Element: {"step_def":"C_MOUSE_CLICK","values":{"element":"text/string","button":"left","click_count":"1","skip_navigation":""}},

Hover Element: {"step_def":"C_HOVER_ELEMENT","values":{"element":"text/string"}},

Focus Element: {"step_def":"C_FOCUS_ELEMENT","values":{"element":"text/string"}},

Fil in field: {"step_def":"C_FILL_FIELD","values":{"element":"text/string","text":"text/string","typing_delay":""}},

Check checkbox/radio button: {"step_def":"C_CHECK_BOX","values":{"element":"text/string"}},

Uncheck checkbox/radio button: {"step_def":"C_UNCHECK_BOX","values":{"element":"text/string"}},

Submit form: {"step_def":"C_SUBMIT_FORM","values":{"element":"text/string","skip_navigation":""}},

Wait for element to exist: {"step_def":"C_WAIT_FOR_ELEMENT","values":{"element":"text/string","timeout":""}},

Wait for element to not exist: {"step_def":"C_WAIT_FOR_NOT_ELEMENT","values":{"element":"text/string","timeout":""}},

Wait for element to contain text: {"step_def":"C_WAIT_FOR_ELEMENT_TEXT","values":{"element":"text/string","text":"text/string","is_regex":"","timeout":""}},

Wait for element to not contain text: {"step_def":"C_WAIT_FOR_NOT_ELEMENT_TEXT","values":{"element":"text/string","text":"text/string","is_regex":"","timeout":""}},

Wait for 1 second: {"step_def":"C_WAIT_FOR_ONE_SECOND","values":{}},

Set Variable: {"step_def":"C_SET_VARIABLE","values":{"name":"textstring","type":"element","options":"text/string","options2":""}},

Validators

HTTP status code: {"step_def":"V_HTTP_STATUS_CODE_IS","values":{"http_status":"200"}},

URL should contain: {"step_def":"V_URL_CONTAINS","values":{"text":"text/string","is_regex":""}},

URL should not contain: {"step_def":"V_URL_DOES_NOT_CONTAIN","values":{"text":"text/string","is_regex":""}},

Title should contain: {"step_def":"V_TITLE_CONTAINS","values":{"text":"text/string","is_regex":""}},

Title should not contain: {"step_def":"V_TITLE_DOES_NOT_CONTAIN","values":{"text":"text/string","is_regex":""}},

Element should exist: {"step_def":"V_ELEMENT_EXISTS","values":{"element":"text/string"}},

Element should not exist: {"step_def":"V_ELEMENT_DOES_NOT_EXIST","values":{"element":"text/string"}},

Element should contain: {"step_def":"V_ELEMENT_CONTAINS_TEXT","values":{"element":"text/string","text":"text/string","is_regex":""}},

Element should not contain: {"step_def":"V_ELEMENT_DOES_NOT_CONTAIN_TEXT","values":{"element":"text/string","text":"text/string","is_regex":""}},

Checkbox/radio button should be checked: {"step_def":"V_BOX_IS_CHECKED","values":{"element":"text/string"}},

Checkbox/radio button not be checked: {"step_def":"V_BOX_IS_NOT_CHECKED","values":{"element":"text/string"}},

HTTP header should contain: {"step_def":"V_HTTP_HEADER_CONTAINS_TEXT","values":{"header":"text/string","text":"text/string","is_regex":""}},
HTTP header should not contain: {"step_def":"V_HTTP_HEADER_DOES_NOT_CONTAIN_TEXT","values":{"header":"text/string","text":"text/string","is_regex":""}},

** Please note if there is a function that is not available in the above but is available in our UI, we can recommend creating a check via the UI and then using an API call to retrieve the syntax of the request.