JSON Object Example
{
    "Timeout": 0,
    "RequestType": "GET",
    "Url": "http://dotcom-monitor.com",
    "Keyword1": "",
    "Keyword2": "",
    "Keyword3": "",
    "UserName": "",
    "UserPass": "",
    "CheckCertificateAuthority": true,
    "CheckCertificateCN": true,
    "CheckCertificateDate": true,
    "CheckCertificateRevocation": true,
    "CheckCertificateUsage": true,
    "FullPageDownload": false,
    "Device_Id": 270725,
    "Task_Type_Id": 1,
    "Name": "http://dotcom-monitor.com",
    "Download_Html": false,
    "Download_Frames": false,
    "Download_StyleSheets": false,
    "Download_Scripts": false,
    "Download_Images": false,
    "Download_Objects": false,
    "Download_Applets": false,
    "Download_Additional": false,
    "ClientCertificate": "",
    "ExpirationReminderInDays": "",
    "GetParams": [],
    "PostParams": [],
    "HeaderParams": [],
    "RawPostData": "",
    "PrepareScript": null,
    "PostScript": null,
    "DNSResolveMode": "Device Cached",
    "DNSserverIP": "",
    "CustomDNSHosts": null,
    "FollowRedirects": true,
    "Id": 489531
}

Fields Description

Field Type Required/Optional Description

RequestType

string

required

 This field defines TYPE of the request.

POSSIBLE VALUES:

  • GET
  • POST
  • HEAD
  • PUT
  • DELETE
  • OPTIONS
  • TRACE
  • PATCH
Example:
"RequestType": "GET"

Url

string

required

 Field for a monitoring address.

Example:

Keyword1

string

optional

 First Keyword search field. See how to create keywords here.

Example:
"Keyword1": "{[(\"User\"&\"Terms\")|!\"Error\"]}"

Keyword2

string

optional

 Second Keyword search field.

Example:
"Keyword2": "Contact us"

Keyword3

string

optional

 Third Keyword search field.

Example:
"Keyword3": "Terms"

UserName

string

optional

 This field contains a username for HTTP basic access authentication

Example:
"UserName": "username"

UserPass

string

optional

 This field contains a password for HTTP basic access authentication

Example:
"UserPass": "password"

CheckCertificateAuthority

boolean

optional

 When enabled – verifies if the certificate chain doesn’t contain untrusted root cert.

Example:
"CheckCertificateAuthority": true

CheckCertificateCN

boolean

optional

 When enabled – validates that address you navigate matches with address certificate was signed to.

Example:
"CheckCertificateCN": true

CheckCertificateDate

boolean

optional

 When enabled – verifies certificate expiration date.

Example:
"CheckCertificateDate": true

CheckCertificateRevocation

boolean

optional

 When enabled – validates that the certificates chain doesn’t contain one which was revoked.

Example:
"CheckCertificateRevocation": true

CheckCertificateUsage

boolean

optional

 When enabled – verifies cert. chain for the wrong usage of any intermediate cert.

Example:
"CheckCertificateUsage": true

ClientCertificate

string

optional

  If you require client certificates to access your site, create a ticket to upload your SSL certificate so we can install them on the monitoring agents.  After the certificate has been installed you can specify the certificate name here.

Example:
"ClientCertificate": "cert.cer"
ExpirationReminderInDays int32 optional A reminder that notifies (as an error) about certificate expiration.

Example:
"ExpirationReminderInDays": "15"

FullPageDownload

boolean

optional

 When the Full-page Download tool is enabled the returned HTML is parsed. Then the parsed elements within the HTML, such as images, style sheets, applets, etc., are downloaded.

Example:
FullPageDownload": true

Download_Html

boolean

optional

 Switch  enabling or disabling HTML elements download.

Example:
"Download_Html": false

Download_Frames

boolean

optional

 Switch  enabling or disabling Frames download.

Example:
"Download_Frames": false

Download_StyleSheets

boolean

optional

 Switch  enabling or disabling Stylesheets download.

Example:
"Download_StyleSheets": false

Download_Scripts

boolean

optional

 Switch  enabling or disabling scripts download.

Example:
"Download_Scripts": false

Download_Images

boolean

optional

 Switch  enabling or disabling images download.

Example:
"Download_Images": false

Download_Objects

boolean

optional

 Switch  enabling or disabling Objects download.

Example:
"Download_Objects": false

Download_Applets

boolean

optional

 Switch  enabling or disabling applets download.

Example:
"Download_Applets": false

Download_Additional

boolean

optional

 Switch  enabling or disabling download of additional content.

Example:
"Download_Additional": false

GetParams

array of strings

optional

 You can specify GET parameters as key and its value.

Example:
"GetParams": [{
            "Name": "key",
            "Value": "value"
        }]

PostParams

array containing strings

optional

 You can specify POST parameters as a key and its value here. To send “row” data, use the RowPostData instead.

Example:
"PostParams": [{
            "Name": "key",
            "Value": "value"
            }]

HeaderParams

array containing strings

optional

 You can specify header parameters as key and its value. If the Content-Type header is not specified for the request, the request will be sent with the default content type application/x-www-form-urlencoded.

Example:
"HeaderParams": [{
      "Name": "key",
      "Value": "value"
            }]

PrepareScript/PostScript

string

optional

 This field can contain C# code, which can be used for specific POST, GET and URL data, for example, random-number generator or some atypical parameters pulling can be created using it. For example, this can be used to generate dynamic URL depending on previous requests (if it gave less than 1000 links – open one URL, else – another.) Please see Using Prepare Script and Post Script or contact technical support for more details on usage.

RowPostData

string

optional

 Use this field to send payloads as “raw” data (JSON, XML, etc.) in your HTTP(S) requests. To send static name-value collection (Form Data), use PostParams instead.
DNSResolveMode string optional POSSIBLE VALUES:

  • Device Cached
  • Non Cached
  • TTL Cached
  • External DNS Server

For detailed explanation please see the “DNS Mode Option” article.
DNSserverIP string optional Field for a custom DNS server IP address.

For detailed explanation please see the “DNS Mode Option” article.
FollowRedirects boolean optional If the Follow Redirects option is set to Yes, the system will follow the path of the URL that is sent with the 301 response and consider each redirect as a separate HTTP request.
Device_Id

int32

required

 READ ONLY Field. Unique device id.

Example:
"Site_Id": 8550

Id

int32

required

*Only for edit operations

 READ ONLY Field. Unique task id

Example:
"Id": 17709

Task_Type_Id

int32

required

 Type of the task field.

Example:
"Task_Type_Id": 1

Name

string

optional

 Task name.

Example:
"Name": "msn.com"

Timeout

int32

optional

 This field defines timeout value (in seconds) for task execution.

Example:
"Timeout": 300