API: HTTP

JSON Object Example

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 destination address

Example:

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 contain a username for HTTP basic access authentication

Example:
"UserName""username"

UserPass

String

This field contain a password for HTTP basic access authentication

Example:
"UserPass""password"

FullPageDownload

Boolean

The HTTP and HTTPS monitoring processes only download the HTML returned by the server in response to a GET or POST request.However, 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., also 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 string objects

You can specify GET parameters as key and its value

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

PostParams

Array of string objects

You can specify POST parameters as key and its value

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

HeaderParams

Array of string objects

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 it can be random-number generator or some atypical parameters pulling. 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 detailed explanation please see “DNS Mode Option” article

DNSserverIP String Field for a custom DNS server IP addressFor detailed explanation please see “DNS Mode Option” article

Device_Id

Int32

READ ONLY Field.Unique device ID.

Example:
"Site_Id": 8550

Task_Type_Id

Int32

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

Example:
"Task_Type_Id": 1

Id

Int32

READ ONLY Field.Unique task id

Example:
"Id": 17709

Name

String

Task name

Example:
"Name":"msn.com"

Timeout

Int32

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

Example:
Timeout": 300