API: HTTPS -

JSON Object Example

{
    "Timeout": 0,
    "RequestType": "POST",
    "Url": "https://www.mobiparking.pl/login",
    "Keyword1": "Historia",
    "Keyword2": "Lista",
    "Keyword3": "Wygenerowane",
    "UserName": "mklimek",
    "UserPass": "ellino10",
    "CheckCertificateAuthority": true,
    "CheckCertificateCN": true,
    "CheckCertificateDate": true,
    "CheckCertificateRevocation": true,
    "CheckCertificateUsage": true,
    "FullPageDownload": false,
    "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": 
    [
        {
            "Name": "test",
            "Value": "test"
        },
        {
            "Name": "password",
            "Value": "test"
        }
    ],
    "HeaderParams": [],
    "PrepareScript": "",
    "DNSResolveMode": "Device Cached",
    "DNSserverIP": null,
    "Device_Id": 82773,
    "Id": 203529,
    "Task_Type_Id": 2,
    "Name": "webpanel login"
}

Fields description

Field Type Description

RequestType

String

This field defines TYPE of the request. Possible values are “GET” and “POST”

Example:

"RequestType": "GET"

Url

String

Field for a monitoring address

Example:

"Url":"https://msn.com/”

Keyword1

String

First Keyword search field.There is a possibility to use keyword expressions like:{[(“keyword1″&”keyword2″)|!”keyword3”]}where

{[ – keyword expression start;

]} – keyword expression end;

() – grouping brackets;

& – logical AND;

| – logical OR;

! – logical NOT;

“string” – a keyword;

Example:

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

Keyword2

String

Second Keyword search field.

Example:

"Keyword2": "Contact us"

Keyword3

String

Third Keyword search field.

Example:

"Keyword3": "Terms"

UserName

String

This field contains a username for HTTP basic access authentication

Example:

"UserName": "username"

UserPass

String

This field contains a password for HTTP basic access authentication

Example:

"UserPass": "password"

CheckCertificateAuthority

Boolean

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

Example:

"CheckCertificateAuthority": true

CheckCertificateCN

Boolean

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

Example:

"CheckCertificateCN": true

CheckCertificateDate

Boolean

When enabled – verifies certificate expiration date

Example:

"CheckCertificateDate": true

CheckCertificateRevocation

Boolean

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

Example:

"CheckCertificateRevocation": true

CheckCertificateUsage

Boolean

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

Example:

"CheckCertificateUsage": true

ClientCertificate

String

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 will specify the certificate name here.

Example:

"ClientCertificate": "cert.cer"

ExpirationReminderInDays

int32

A reminder that notifies (as an error) about certificate expiration.

Example:

"ExpirationReminderInDays": "15"

FullPageDownload

Boolean

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

Switch enabling or disabling HTML elements download

Example:

"Download_Html": false

Download_Frames

Boolean

Switch enabling or disabling Frames download

Example:

"Download_Frames": false

Download_StyleSheets

Boolean

Switch enabling or disabling Stylesheets download

Example:

"Download_StyleSheets": false

Download_Scripts

Boolean

Switch enabling or disabling scripts download

Example:

"Download_Scripts": false

Download_Images

Boolean

Switch enabling or disabling images download

Example:

"Download_Images": false

Download_Objects

Boolean

Switch enabling or disabling Objects download

Example:

"Download_Objects": false

Download_Applets

Boolean

Switch enabling or disabling applets download

Example:

"Download_Applets": false

Download_Additional

Boolean

Switch enabling or disabling download of additional content

Example:

"Download_Additional": false

GetParams

Array of Strings

You can specify GET parameters as key and its value

Example:

"GetParams": [{

"Name": "key",

"Value": "value"

}]

PostParams

Array containing Strings

You can specify POST parameters as key and its value

Example:

"PostParams": [{

"Name": "key",

"Value": "value"

}]

HeaderParams

Array containing Strings

You can specify header parameters as key and its value

Example:

"HeaderParams": [{

"Name": "key",

"Value": "value"

}]

PrepareScript

String

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 contact technical support for more details on usage.

DNSResolveMode

String

Available modes:

Device Cached
Non Cached
TTL Cached
External DNS Server

For a detailed explanation please see “DNS Mode Option” article

DNSserverIP String The field for a custom DNS server IP address, for a detailed explanation please see “DNS Mode Option” article

Int32

READ ONLY Field. Unique device ID.

Example:

"Site_Id": 8550

Int32

READ ONLY Field. Unique task id

Example:

"Id": 17709

Task_Type_Id

Int32

Type of the task field. Please check Potential values for “Task_type_id” in an appropriate table

Example:

"Task_Type_Id": 2

Name

string

Task name

Example:

"Name": "msn.com"

Timeout

Int32

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

Example:

"Timeout": 300