JSON Object Example
{

"Timeout": 60,

"Url": "wss://demo.piesocket.com/v3/channel_1?api_key=oCdCMcMPQpbvNjUIzqtvF1d2X2okWpDQj4AwARJuAgtjhzKxVEjdCjwm&notify_self",

"Keyword1": "",

"UserName": "",

"UserPass": "",

"HeaderParams":[],

"GetParams":[],

"RawPostData": "",

"PrepareScript": null,

"PostScript": null,

"CheckCertificateAuthority": true,

"CheckCertificateCN": true,

"CheckCertificateDate": true,

"CheckCertificateRevocation": true,

"CheckCertificateUsage": true,

"ClientCertificate": "",

"ExpirationReminderInDays": "",

"DNSResolveMode": "Device Cached",

"DNSserverIP": "",

"CustomDNSHosts": "",

"Device_Id": 14008,

"Id": 26338,

"Task_Type_Id": 74,

"Name": "wss://demo.piesocket.com/"

}

See also: WebSocket Monitoring

Fields Description

Field Type Required/Optional Description

Url

string

required

The WebSocket URL of the endpoint or IP address of the WebSocket URL to check.

Keyword1

string

optional

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

UserName

string

optional

This field contains a username for HTTP basic access authentication.

UserPass

string

optional

This field contains a password for HTTP basic access authentication.

HeaderParams

array of strings

optional

You can specify header parameters as key-value pairs. 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.

GetParams

array of strings

optional

You can specify GET parameters as key-value pairs.

RawPostData

string

optional

If you need to transfer data to the target endpoint, specify a message in a string or binary format in this field.

CheckCertificateAuthority

boolean

optional

Verifies if the certificate chain doesn’t contain an untrusted root certificate.

CheckCertificateCN

boolean

optional

Validates that address you navigate matches with the address the certificate was signed to.

CheckCertificateDate

boolean

optional

Checks the certificate expiration date.

CheckCertificateRevocation

boolean

optional

Validates that the certificate chain doesn’t contain a revoked certificate.

CheckCertificateUsage

boolean

optional

Verifies the certificate chain for the correct usage of intermediate certificates.

ClientCertificate

string

optional

The name of the client SSL certificate. If your connection requires client certificates, create a ticket to upload your SSL certificate so we can install them on the monitoring agents. When the certificate is installed you can specify the certificate name in this field.
ExpirationReminderInDays int32 optional A reminder that notifies (as an error) about certificate expiration.

PrepareScript

string

optional

This field can contain C# code, which can be used for specific POST, GET and URL data. In addition, with PrepareScript code you can enable response or request headers modification, network throttling, and redirecting the device traffic through the specified proxy server. Please see Using Prepare Script and Post Script or contact technical support for more details on usage.

PostScript

string

optional

The C# Post Script can be applied to the response to track any custom information in the response as cookies or a header description. In addition, an assert can be added to validate a specific response header for specified content and generate an error if the condition is not met. Please see Using Prepare Script and Post Script or contact technical support for more details on usage.
DNSResolveMode string optional POSSIBLE VALUES:

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

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

DNSserverIP string optional The field for a custom DNS server IP address.

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

Device_Id

int32

required

READ ONLY Field. Unique device ID.

Id

int32

required

*Only for edit operations

READ ONLY Field. Unique task ID.

Task_Type_Id

int32

required

Type of the task field.

Name

string

optional

Task name.

Timeout

int32

optional

This field defines the timeout value (in seconds).