Monitor Object Data Fields

Last modified on March 25, 2021

AlertSite API operations for managing monitors use the following data fields to represent monitor configuration.

To learn more about monitor configuration in AlertSite, see Monitor Settings.

All field names and values are case-sensitive.

Common fields

Below are the fields common for all monitors:

access_type

Read-only. String. Indicates the user access level, can be changed with enhanced monitor permissions. Possible values: View (default), Edit.

alert_note

String. A monitor-specific alert note. Up to 1000 characters, longer notes will be truncated.

allow_internal_testing

Boolean. The Allow AlertSite QA testing option. Default value: true.

billing_plancode

String. The AlertSite billing plan for the monitor. For example, UBM-A/A (not UBM - A/A:1:50). You can see your available plans in  > Settings > Plan Details (in AlertSite UXM) or Account > Account Summary (in AlertSite 1.0).

When creating new monitors, make sure to use a valid plan code that supports this monitor type. When in doubt, check which plan is used by your existing monitors and use the same plan code.

blackout_ids

Read-only. An array of monitor blackouts IDs. For example:

"blackout_ids": [
  "103652",
  "102412",
]

custom_properties

An array of custom monitor properties. Only properties with assigned values are included in this array. Each property is specified by its ID, name, current value, and value ID. For example, if a monitor uses two custom properties, Environment=Development and Application=App1, the data would look like:

"custom_properties":[
  {
    "id": 228,
    "name": "Environment",
    "value": "Development",
    "value_id": 550
  },
  {
    "id": 230,
    "name": "Application",
    "value": "App1",
    "value_id": 620
  }
]

To change the property values, send back the custom_properties array containing the property IDs and new value_id for each property. You can get all IDs by using GET /properties.

"custom_properties":[
  { "id": 228, "value_id": 556 }
]

Any properties not included in custom_properties will be set to unassigned. An empty custom_properties array will set all custom properties to unassigned.

customer_id

Read-only. Integer. The AlertSite customer ID without the starting C. For example, 12345.

enabled

Boolean. Indicates whether the monitor is enabled or disabled. Default value: true.

has_active_performance_alerts

Read-only. Boolean. Indicates whether the monitor has enabled performance alerts.

has_performance_alerts

Note: The field does not apply to type=selenium.

Read-only. Boolean. Indicates whether performance alerts have been added to the monitor. Default value: true.

has_sla

Read-only. Boolean. Indicates whether SLA monitoring is configured for the monitor. Default value: true.

home_location

Integer. The ID of the primary monitoring location for the monitor. You can find the IDs of AlertSite’s global locations here. If you use private locations, you can get their IDs by using the Get Locations operation.

In the Get Monitors response, 0 means the account’s default primary location.

id

Read-only. Integer. The monitor ID.

interval

Integer. The monitoring interval, in minutes. Possible values: 1, 2, 3, 4, 5 (default), 6, 10, 15, 20, 30, 60, 120.

locations

An array of monitoring locations used by the monitor. Each location is specified by the ID, name, and region.

"locations": [
  {
    "id": 11388,
    "name": " EndPoint: Private Node",
    "region": 0
  },
  {
    "id": 20,
    "name": "Atlanta, GA",
    "region": 1
  },
  {
    "id": 10,
    "name": "Fort Lauderdale, FL",
    "region": 1
  }
]

locations[].id

locations[].name

locations.[]region

mode

String. The monitoring mode used for the monitor. Possible values:

  • Primary

  • Global Notify

  • Global Verify (default)

  • Round Robin

  • SLA (MultiPOP)

monitor_location_count

Integer. The number of locations per interval when using rotated locations, or 0 if rotated locations are not used.

To disable rotated locations, set monitor_location_count to 0.

monitor_uses_own_locations

Read-only. Boolean. Indicates whether the monitor uses private locations. Default value: true.

name

String. The monitor name. When adding or editing monitors, the name should not contain characters " ' \.

note

String. A monitor-specific dashboard note. Up to 1000 characters, longer notes will be truncated.

notify_on_error

Boolean. Indicates whether availability alerts are enabled for this monitor. Default value: true.

If omitted when adding a monitor, it defaults to the value specified by Enable alerts in your account settings.

retry_on_failure

Note: The field does not apply to type=perfecto.

Boolean. The Enable local retry option. Default value: true.

rotate_locations

Boolean. The Rotate Locations option. Default value: false.

sla_id

Read-only. The SLA configuration ID.

timeout

Note: The field does not apply to type=api,perfecto.

Integer. The Browser timeout option, in seconds. Possible values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30 (default), 45, 60, 75, 90, 120, 150, 180, 240, 300.

type

String. The monitor type. Possible values:

Value Monitor Type

api

SoapUI API monitor

dejaclick

Real-browser or mobile web monitor (DéjàClick)

email-imap

Email server (IMAP) monitor

email-pop

Email server (POP) monitor

email-round-trip

Round-trip email monitor

email-smtp

Email server (SMTP) monitor

ftp

FTP monitor

ftp-ssl

FTPS (FTP over SSL) monitor

name-server

DNS (Name Server) monitor

perfecto

Perfecto Mobile monitor

ping

Ping monitor

selenium

Selenium monitor

tcp

TCP monitor

website

Web URL monitor

website-api

API endpoint monitor

website-ssl

Web URL monitor for https:// URLs

website-ssl-api

API endpoint monitor for https:// endpoints

SoapUI monitor fields

Below are the fields that can be applied to type=api monitors:

capture

Shows the details of the collected test logs. For example:

"capture": {
  "headers": true,
  "images": true,
  "level": "All Events",
  "mimetype": "image/jpeg",
  "sources": true
}

capture.headers

capture.images

capture.level

capture.mimetype

capture.sources

is_transaction

Read-only. Shows whether the monitor is a multi-step transaction.

monitor_agent

The playback engine used to run the monitor. Possible values:

  • null – the default engine, which is ReadyAPI 1.9

  • ReadyAPI 1.1

  • ReadyAPI 1.9

  • TestEngine

Default value: null.

project_name

Read-only. The name of the uploaded SoapUI project.

project_password

The password of the password-protected SoapUI project.

replay_success

Read-only. Shows whether the monitor has successfully run Test on Demand.

script

The Base64-encoded contents of the SoapUI project file.

Note: The content of the project file is shown only when the show_scripts parameter is set to true.

script_id

The ID of the uploaded script.

ssl_cert_format

Read-only. The SSL certificate format.

ssl_cert_id

The SSL certificate ID.

ssl_cert_name

Read-only. The SSL certificate name.

subtype

Reserved for internal use.

subtype_application

Reserved for internal use.

subtype_name

Reserved for internal use.

test_case

The test case name of the uploaded SoapUI project.

test_suite

The test suite name of the uploaded SoapUI project.

transaction_steps

Read-only. The number of steps in the monitor.

transaction_steps_allowed

The maximum number of steps per SoapUI test allowed by your AlertSite billing plan. The limit is 5 in AlertSite Community and Pro, and 50 on most Enterprise plans.

transaction_trace

The Enable Transaction Trace option. Default value: false.

use_client_ssl_cert

Shows whether a user supplied an SSL certificate. Default value: false

use_ssl_version

String. Version of the SSL or TLS protocol to be used when connecting. Possible values:

Value Description
"" (empty string) Auto-Detect (Default)
"2" SSL 2.0
"3" SSL 3.0
"10" TLS 1.0
"11" TLS 1.1
"12" TLS 1.2

DéjàClick monitor fields

Below are the fields that can be applied to the type=dejaclick monitors.

browser_type

Read-only. The browser used by DéjàClick monitors. Possible values:

  • Google Chrome

  • Internet Explorer

  • Firefox

Defaults to Firefox if it has not been specified when adding the monitor. It cannot be changed in the existing monitors.

capture

Shows the details of the collected test logs. For example:

"capture": {
  "headers": true,
  "images": true,
  "level": "All Events",
  "mimetype": "image/jpeg",
  "sources": true
}

capture.headers

capture.images

capture.level

capture.mimetype

capture.sources

check_fullpage_missing_objects

The Alert if objects are missing or new option.

check_fullpage_object_sizes

content_views

The ContentView data. For example:

"content_views": [
  {
    "id": 1000000711,
    "inherit_global_errors": true,
    "name": "Amazon only",
    "notify_on_error": true
  }
]

content_views[].id

content_views[].inherit_global_errors

content_views[].name

content_views[].notify_on_error

continue_playback_on_timeout

The Continue Playback on Timeout option. Default value: false.

fullpage_object_timeout

The fullpage object timeout, in seconds. Possible values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 (default), 15, 20, 25, 30, 45, 60, 75, 90, 120, 150, 180, 240, 300.

has_capture

Read-only. Shows whether the monitor has the Capture options enabled.

has_content_views

Read-only. Shows whether the monitor has ContentViews.

has_mobile_locations

Read-only. Shows whether the monitor is using one of the Mobile network provider locations (ATT or Sprint).

has_multipop

Read-only. Boolean. The monitor is running in SLA (MultiPOP) monitoring mode.

has_user_experience

Read-only. Shows whether the monitor has user experience measurements enabled.

interval_fullpage

How often to measure the fullpage response time for the monitored site or transaction.

Possible values: -1 (disabled, default), 1, 2, 3, 4, 5, 6, 10, 15, 20, 60, 120.

This value must be a multiple of interval. For example, if interval is 10, interval_fullpage can be 10, 20, 30, 60, 120.

ipv6_enabled

The Use IPv6 option.

is_content_view

Read-only. Shows whether the monitor has ContentViews.

is_transaction

Read-only. Shows whether the monitor is a multi-step transaction.

keyword_action

The action to perform when the keyword specified in keyword-string is found or not. Possible values:

  • Generate an error (default)

  • Continue waiting

keyword_allow_line_wrap

The Allow Line Wrap option. Commands AlertSite to match keyword values even with line breaks. Default value: true.

keyword_match_case

The Match Case option. Commands AlertSite to consider the character case during the keyword validation. Default value: true.

keyword_match_invert

The Invert Match option. Default value: false.

keyword_match_type

Specifies whether keyword_string contains plain text or a regular expression. Possible values:

  • Plain Text (default)

  • Regular Expression

keyword_match_whole_word

The Match Whole Word/Phrase option. Commands AlertSite to match the whole word or phrase only during the keyword validation. Default value: true.

keyword_normalize_spaces

The Normalize Blank Spaces option. Default value: true.

keyword_string

The word, phrase, or regular expression to find on the monitored web page.

Regular expressions must be specified as strings ("Hello.*There!") rather than regular expression literals (/Hello.*There!/). Also, tokens like \d must be specified with double backslashes: \\d.

Default value: '' (empty string).

last_modified

Read-only. The date and time when the DéjàClick script was last modified.

mobile_location_count

Read-only. The number of the Mobile network provider locations (ATT or Sprint) used by the monitor.

mobile_type

Read-only. The type of the mobile devices used by mobile web monitoring.

notify_on_content_change

The Alert on content change option. Triggers an alert if the size of the last page in the test changed since the last check.

notify_on_fullpage_errors

The Alert on page asset errors option. Used only if full-page monitoring is enabled (that is, interval_fullpage is different from -1).

script

The text contents of the script file.

Note: The content of the script file is shown only when the show_scripts parameter is set to true.

script_created

Read-only. The DéjàClick script creation details: the date and time, DéjàClick version, and the browser type and version. For example:

"script_created": "Wed, 28 Mar 2018 08:02:37 GMT (client version 1.4.0.0, Chrome 65.0.3325.181)"

script_modified

Read-only. The DéjàClick latest script update details: the date and time, DéjàClick version, and the browser type and version. For example:

"script_modified": "Wed, 15 May 2019 07:35:20 GMT (client version 2.5.0.1, Firefox 17.0)"

script_modified_by_user

Read-only. The date and time when a user made some changes to the script.

script_replayed_successfully

Read-only. Shows whether the script has been validated by Test On Demand after being uploaded.

script_status

Read-only. Shows whether the script has been played back before uploading it to AlertSite. Possible values:

  • Replay Successful

  • Replay Failure

  • Replay Incomplete

  • Replay Warning

  • Unavailable

ssl_cert_format

Read-only. The SSL certificate format.

ssl_cert_id

The SSL certificate ID.

ssl_cert_name

Read-only. The SSL certificate name.

step_timeout

Maximum acceptable full-page response time for each web page. This value includes the load time of the page and all of its images, scripts, and other resources.

subtype

Reserved for internal use.

subtype_application

Reserved for internal use.

subtype_name

Reserved for internal use.

third_party_document_errors

The Enable third-party document errors option. Default value: false.

traceroute_on_error

The TCP Traceroute on Error option. If true, the monitor runs a TCP traceroute to your website when it detects a network connectivity problem (status 1 or 2), and sends the results to all email alert recipients. The traceroute shows the path that data packets are taking from a monitoring location to your server, and can help administrators and engineers troubleshoot problems. Default value: true.

transaction_events

Read-only. The number of transaction events in the monitor.

transaction_password

The password to unlock the password-protected script variables.

transaction_steps

Read-only. The number of steps in the monitor.

transaction_steps_allowed

The maximum number of steps per allowed by your AlertSite billing plan. The limit is 5 in AlertSite Community and Pro, and 50 on most Enterprise plans.

transaction_trace

The Enable Transaction Trace option. Default value: false.

url

The URL or domain to monitor.

use_client_ssl_cert

Shows whether a user supplied an SSL certificate. Default value: false

user_experience_base_page_only

The Show Only Root Page UX Values option. Collects timings only for the base page without frames. Available only if user_experience_enabled is true.

user_experience_enabled

The Enable UX option. If true, the monitor collects the First Paint and Above the Fold page rendering timings.

Email server monitor fields

Below are the fields that can be applied to the type=email-imap,email-pop,email-round-trip,email-smtp monitors:

email

Applies to: type=email-round-trip

The email address to send the test message to.

email_password

Applies to: type=email-round-trip

The password to access the email.

email_username

Applies to: type=email-round-trip

The username to access the email.

hostname

Applies to: type=email-imap,email-pop,email-smtp

The host name of the server.

imap_password

Applies to: type=email-imap

Reserved for internal use.

imap_username

Applies to: type=email-imap

Reserved for internal use.

ipv4

Applies to: type=email-imap,email-pop,email-smtp

The IP (IPv4) address of the tested server.

pop3_hostname

Applies to: type=email-round-trip

The POP3 server to access the inbox of the email. This is the address of the POP3 server that the mail will be read from.

pop_password

Applies to: type=email-pop

The password to access pop3_hostname.

pop_username

Applies to: type=email-pop

The username to access pop3_hostname.

port

Applies to: type=email-imap,email-pop,email-smtp

The email server monitors support only those email servers that use the following ports:

  • POP3 – port 110

  • SMTP – port 25 (default) or 587

  • IMAP – port 143

Other port numbers are not supported.

resolve_dns

Applies to: type=email-imap,email-pop,email-smtp

The Resolve DNS option.

If true, AlertSite monitors the url, and ipv4 returns the IP address that your site resolved to when the monitor was created.

If false, AlertSite monitors the specified ipv4 instead of the url.

smtp_hostname

Applies to: type=email-round-trip

The SMTP server (outgoing mail server) to send the test email from.

smtp_password

Applies to: type=email-smtp

Reserved for internal use.

smtp_username

Applies to: type=email-smtp

Reserved for internal use.

traceroute_on_error

Applies to: type=email-imap,email-pop,email-round-trip,email-smtp

The TCP Traceroute on Error option. If true, the monitor runs a TCP traceroute to your website when it detects a network connectivity problem (status 1 or 2), and sends the results to all email alert recipients. The traceroute shows the path that data packets are taking from a monitoring location to your server, and can help administrators and engineers troubleshoot problems. Default value: true.

FTP and FTPS monitor fields

Below are the fields that can be applied to the type=ftp, ftp-ssl monitors.

enable_ftp_upload

ftp_password

The FTP password required for FTP server authentication if enable_ftp_upload is true.

ftp_username

The FTP username required for FTP server authentication if enable_ftp_upload is true.

hostname

The host name of the server.

ipv4

The IP (IPv4) address of the tested server.

port

The custom port number used by the monitored site, or an empty string if a standard port is used. Typical ports are 80 for HTTP and 443 for HTTPS.

resolve_dns

The Resolve DNS option.

If true, AlertSite monitors the url, and ipv4 returns the IP address that your site resolved to when the monitor was created.

If false, AlertSite monitors the specified ipv4 instead of the url.

ssl_cert_format

Applies to: type=ftp-ssl only

Read-only. The SSL certificate format.

ssl_cert_id

Applies to: type=ftp-ssl only

The SSL certificate ID.

ssl_cert_name

Applies to: type=ftp-ssl only

Read-only. The SSL certificate name.

traceroute_on_error

The TCP Traceroute on Error option. If true, the monitor runs a TCP traceroute to your website when it detects a network connectivity problem (status 1 or 2), and sends the results to all email alert recipients. The traceroute shows the path that data packets are taking from a monitoring location to your server, and can help administrators and engineers troubleshoot problems. Default value: true.

use_client_ssl_cert

Applies to: type=ftp-ssl only

Shows whether a user supplied an SSL certificate. Default value: false

use_ssl_version

Applies to: type=ftp-ssl only

String. Version of the SSL or TLS protocol to be used when connecting. Possible values:

Value Description
"" (empty string) Auto-Detect (Default)
"2" SSL 2.0
"3" SSL 3.0
"10" TLS 1.0
"11" TLS 1.1
"12" TLS 1.2

DNS (Name Server) monitor fields

Below are the fields that can be applied to the type=name-server monitors.

hostname

The host name of the server.

ipv4

Reserved for internal use.

name_to_resolve

The Name to Resolve option. The domain name to test the DNS lookup for.

name_to_resolve_id

The ID of the domain name (name_to_resolve).

port

Reserved for internal use.

resolve_dns

Reserved for internal use.

traceroute_on_error

The TCP Traceroute on Error option. If true, the monitor runs a TCP traceroute to your website when it detects a network connectivity problem (status 1 or 2), and sends the results to all email alert recipients. The traceroute shows the path that data packets are taking from a monitoring location to your server, and can help administrators and engineers troubleshoot problems. Default value: true.

Perfecto monitor fields

Below are the fields that can be applied to the type=perfecto monitors.

monitor_offset

The Monitor Offset option. The offset from the beginning of the hour when the run starts.

perfecto_hostname

The host name of the Perfecto MobileCloud host. Default value: www.perfectomobile.com.

perfecto_password

Your password in Perfecto MobileCloud.

perfecto_script_name

Read-only. The Selected Script option. For example: Public/Monitoring Script.

perfecto_script_value

The Perfecto repository location of the script, for example, PUBLIC:Monitoring Script.xml.

perfecto_username

Your username in Perfecto MobileCloud.

Ping monitor fields

Below are the fields that can be applied to the type=ping monitors.

hostname

The host name of the server.

ipv4

The IP (IPv4) address of the tested server.

port

The custom port number used by the monitored site, or an empty string if a standard port is used. Typical ports are 80 for HTTP and 443 for HTTPS.

resolve_dns

The Resolve DNS option.

If true, AlertSite monitors the url, and ipv4 returns the IP address that your site resolved to when the monitor was created.

If false, AlertSite monitors the specified ipv4 instead of the url.

traceroute_on_error

The TCP Traceroute on Error option. If true, the monitor runs a TCP traceroute to your website when it detects a network connectivity problem (status 1 or 2), and sends the results to all email alert recipients. The traceroute shows the path that data packets are taking from a monitoring location to your server, and can help administrators and engineers troubleshoot problems. Default value: true.

Selenium monitor fields

Below are the fields that can be applied to the type=selenium monitors.

capture

Shows the details of the collected test logs. For example:

"capture": {
  "headers": true,
  "images": true,
  "level": "All Events",
  "mimetype": "image/jpeg",
  "sources": true
}

capture.headers

capture.images

capture.level

capture.mimetype

capture.sources

fullpage_object_timeout

The fullpage object timeout, in seconds. Possible values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 (default), 15, 20, 25, 30, 45, 60, 75, 90, 120, 150, 180, 240, 300.

is_transaction

Read-only. Shows whether the monitor is a multi-step transaction.

replay_success

Read-only. Shows whether the monitor has successfully run Test on Demand.

script

Empty value. To download a JAR file, use the GET /monitors/{id}?download_script=true operation.

script_id

The ID of the uploaded script.

step_timeout

Maximum acceptable full-page response time for each web page. This value includes the load time of the page and all of its images, scripts, and other resources.

transaction_steps_allowed

The maximum number of steps per Selenium script allowed by your AlertSite billing plan. The limit is 5 in AlertSite Community and Pro, and 50 on most Enterprise plans.

TCP monitor fields

Below are the fields that can be applied to the type=tcp monitors.

hostname

The host name of the server.

ipv4

The IP (IPv4) address of the tested server.

port

The custom port number used by the monitored site, or an empty string if a standard port is used. Typical ports are 80 for HTTP and 443 for HTTPS.

resolve_dns

The Resolve DNS option.

If true, AlertSite monitors the url, and ipv4 returns the IP address that your site resolved to when the monitor was created.

If false, AlertSite monitors the specified ipv4 instead of the url.

traceroute_on_error

The TCP Traceroute on Error option. If true, the monitor runs a TCP traceroute to your website when it detects a network connectivity problem (status 1 or 2), and sends the results to all email alert recipients. The traceroute shows the path that data packets are taking from a monitoring location to your server, and can help administrators and engineers troubleshoot problems. Default value: true.

Single URL monitor fields

Below are the fields that can be applied to the type=website,website-ssl monitors.

check_ssl_expiration_dates

Applies to: type=website-ssl only

The Report Expired SSL Certificates option of Secure Web URL monitors. Possible values:

  • Disabled (default)

  • Expired

  • 1 Day

  • 2 Days

  • 7 Days

  • 15 Days

  • 30 Days

get

The GET request method parameters. For example:

"get": {
  "check_fullpage_missing_objects": false,
  "check_fullpage_object_sizes": false,
  "fullpage_object_timeout": 10,
  "http_302_is_error": false,
  "http_401_is_error": false,
  "http_caching": false,
  "http_compression": false,
  "interval_fullpage": -1,
  "keyword_match_invert": false,
  "keyword_match_type": "Plain Text",
  "keyword_string": "",
  "notify_on_fullpage_errors": false
}

get.check_fullpage_missing_objects

get.check_fullpage_object_sizes

get.fullpage_object_timeout

get.http_302_is_error

get.http_401_is_error

get.http_caching

get.http_compression

get.interval_fullpage

get.keyword_match_invert

get.keyword_match_type

get.keyword_string

get.notify_on_fullpage_errors

head

The HEAD request method parameters. For example:

"head": {
  "http_basic_auth_password": "",
  "http_basic_auth_username": "",
  "http_follow_redirects": true,
  "http_user_agent": "IE 6 -- Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.0; .NET CLR 1.0.3705; .NET CLR 1.1.4322; AlertSite)",
  "http_version": "1.0",
  "ipv4": "52.94.225.248",
  "port": "",
  "resolve_dns": true
}

head.http_basic_auth_password and head.http_basic_auth_username

head.http_follow_redirects

head.http_user_agent

head.http_version

head.ipv4

head.port

head.resolve_dns

http_method

The request method. Default value: get.

notify_on_content_change

The Alert on content change option. Triggers an alert if the size of the last page in the test changed since the last check.

post

The POST request method parameters. For example:

"post": {
  "http_header_use_custom": true,
  "http_post_data_key_value_pairs": "POST /post HTTP/1.1\r\nuuid: {{uuid}}\r\n\r\n",
  "http_post_data_raw": true
}

post.http_header_use_custom

Must be true if http_post_data_key_value_pairs includes the request headers – either just the headers (for GET or HEAD), or both the headers and body. false otherwise.

The Send HTTP Headers exactly as entered option of AlertSite 1.0. Default value: false.

post.http_post_data_key_value_pairs

This field, along with http_post_data_raw and http_header_use_custom, specifies the request headers and/or body. There are several ways to format http_post_data_key_value_pairs depending on the desired contents of the HTTP request.

GET or HEAD requests without headers

The postxxx fields are not used in this case, and the values will be:

"http_header_use_custom": false,
"http_post_data_key_value_pairs": null,
"http_post_data_raw": false

Requests with custom headers and body (JSON, XML, SOAP, and others)

This use case is for any requests with custom headers, and also for PUT, PATCH, and DELETE requests (http_method=CUSTOM). In this case, http_post_data_key_value_pairs contains a complete raw request, including the relative request URL, headers (except Host, which will be inferred from the url), and an optional request body. Headers and body must be separated by a blank line.

For example, a POST JSON request that looks like:

POST /users HTTP/1.1
Host: api.example.com
Content-Type: application/json

{
  "username": "trillian",
  "is_admin": true
}

is encoded as:

"http_header_use_custom": true,
"http_post_data_key_value_pairs": "POST /users HTTP/1.1\r\nContent-Type: application/json\r\n\r\n{\"username\": \"trillian\", \"is_admin\": true}",
"http_header_use_custom": true,

http_header_use_custom must be true, and http_post_data_raw is ignored.

POST form data (application/x-www-form-urlencoded)

http_post_data_key_value_pairs contains the name=value pairs one per line, and the values should not be percent-encoded. AlertSite will build the request body add the Content-Type: application/x-www-form-urlencoded header automatically during the monitor playback.

For example, to post

name=Gerald O'Toole
email=gerald@example.com
company=ABC Corp

use

"http_header_use_custom": false
"http_post_data_key_value_pairs": "name=Gerald O'Toole\r\nemail=gerald@example.com\r\ncompany=ABC Corp", "http_post_data_raw": false

The http_post_data_raw and http_header_use_custom fields must be false.

post.http_post_data_raw

This will typically be false. Use true only if you are POSTing form data and the request is configured as follows:

  • http_method=POST

  • http_post_data_key_value_pairs specifies form data that is already form-encoded, for example:

    email=anne%40example.com&company=ABC+Corp

  • http_post_data_key_value_pairs only contains the form data and does not contain any headers.

The POST exactly as entered option of AlertSite 1.0. Default value: false.

ssl_cert_format

Applies to: website-ssl only

Read-only. The SSL certificate format.

ssl_cert_id

Applies to: website-ssl only

The SSL certificate ID.

ssl_cert_name

Applies to: website-ssl only

Read-only. The SSL certificate name.

traceroute_on_error

The TCP Traceroute on Error option. If true, the monitor runs a TCP traceroute to your website when it detects a network connectivity problem (status 1 or 2), and sends the results to all email alert recipients. The traceroute shows the path that data packets are taking from a monitoring location to your server, and can help administrators and engineers troubleshoot problems. Default value: true.

transaction_trace

The Enable Transaction Trace option. Default value: false.

url

The URL or domain to monitor.

use_client_ssl_cert

Applies to: type=website-ssl only

Shows whether a user supplied an SSL certificate. Default value: false

use_ssl_version

Applies to: type=website-ssl only

String. Version of the SSL or TLS protocol to be used when connecting. Possible values:

Value Description
"" (empty string) Auto-Detect (Default)
"2" SSL 2.0
"3" SSL 3.0
"10" TLS 1.0
"11" TLS 1.1
"12" TLS 1.2

API endpoint monitor fields

Below are the fields that can be applied to the type=website-api,website-ssl-api monitors.

api_steps

Required. The API monitor step settings. Each step corresponds to an individual HTTP request.

The example of the 2-step monitor that performs a GET request and a POST request:

"api_steps": [
 {
   "assertions": [
     {
       "comparison": "exists",
       "property": "uuid",
       "source": "JSON Response",
       "value": ""
     }
   ],
   "head": {
     "http_basic_auth_password": "",
     "http_basic_auth_username": "",
     "preemptive_authentication": false
   },
   "http_method": "GET",
   "post": null,
   "step_name": "Get UUID",
   "step_number": 1,
   "url": "http://httpbin.org/uuid",
   "variables": [
     {
       "name": "uuid",
       "property": "uuid"
     }
   ]
 },
 {
   "assertions": [
     {
       "comparison": "exists",
       "property": "json.uuid",
       "source": "JSON Response",
       "value": ""
     }
   ],
   "head": {
     "http_basic_auth_password": "",
     "http_basic_auth_username": "",
     "preemptive_authentication": false
   },
   "http_method": "CUSTOM",
   "post": {
     "http_header_use_custom": true,
     "http_post_data_key_value_pairs": "POST /post HTTP/1.1\nContent-Type: application/json\n\n{\n \"uuid\": \"{{uuid}}\"\n}",
     "http_post_data_raw": true
   },
   "step_name": "Send UUID",
   "step_number": 2,
   "url": "http://httpbin.org/post",
   "variables": []
 }
]

The HTTP request configuration includes several fields:

api_steps[].assertions

api_steps[].head

api_steps[].http_method

api_steps[].post

api_steps[].step_name

api_steps[].step_number

api_steps[].url

api_steps[].variables

capture

Shows the details of the collected test logs. For example:

"capture": {
  "headers": true,
  "images": true,
  "level": "All Events",
  "mimetype": "image/jpeg",
  "sources": true
}

capture.headers

capture.images

capture.level

capture.mimetype

capture.sources

get

The GET request method parameters. For example:

"get": {
  "check_fullpage_missing_objects": false,
  "check_fullpage_object_sizes": false,
  "fullpage_object_timeout": 10,
  "http_302_is_error": false,
  "http_401_is_error": false,
  "http_caching": false,
  "http_compression": false,
  "interval_fullpage": -1,
  "keyword_match_invert": false,
  "keyword_match_type": "Plain Text",
  "keyword_string": "",
  "notify_on_fullpage_errors": false
}

get.check_fullpage_missing_objects

get.check_fullpage_object_sizes

get.fullpage_object_timeout

get.http_302_is_error

get.http_401_is_error

get.http_caching

get.http_compression

get.interval_fullpage

get.keyword_match_invert

get.keyword_match_type

get.keyword_string

get.notify_on_fullpage_errors

local_validation

Shows whether the Use Swagger Inspector option is enabled. Default value: false.

monitor_agent

The playback engine used to run the monitor. Possible values:

  • null – the default engine, which is ReadyAPI 1.9

  • ReadyAPI 1.9

  • TestEngine

Default value: null.

ssl_cert_format

Applies to: website-ssl-api only

Read-only. The SSL certificate format.

ssl_cert_id

Applies to: website-ssl-api only

The SSL certificate ID.

ssl_cert_name

Applies to: website-ssl-api only

Read-only. The SSL certificate name.

transaction_steps

Read-only. The number of steps in the monitor.

transaction_steps_allowed

The maximum number of steps per test allowed by your AlertSite billing plan. The limit is 5 in AlertSite Community and Pro, and 50 on most Enterprise plans.

transaction_trace

The Enable Transaction Trace option. Default value: false.

use_client_ssl_cert

Applies to: type=website-ssl-api only

Shows whether a user supplied an SSL certificate. Default value: false

use_ssl_version

Applies to: type=website-ssl-api only

String. Version of the SSL or TLS protocol to be used when connecting. Possible values:

Value Description
"" (empty string) Auto-Detect (Default)
"2" SSL 2.0
"3" SSL 3.0
"10" TLS 1.0
"11" TLS 1.1
"12" TLS 1.2

See Also

AlertSite Management API

Highlight search results