JSON Object Example
{
    "Timeout": 0,
    "Server": "127.0.0.1",
    "LoginToServer": false,
    "UserName": "",
    "Password": "",
    "Directory": "",
    "GetDirectoryListing": false,
    "CheckFile1": "",
    "CheckFile2": "",
    "CheckFile3": "",
    "DownloadFile": "",
    "Encryption": "TLS/SSL explicit",
    "DNSResolveMode": "Device Cached",
    "DNSserverIP": "",
    "Device_Id": 87303,
    "Id": 211739,
    "Task_Type_Id": 18,
    "Name": "127.0.0.1"
}

Fields Description

Field Type Required/Optional Description

Server

 String

required

 FTP Server Address

Example:
"Server": "ftp.nowhere.com"

LoginToServer

Boolean

optional

 When enabled – login operation will be performed during monitoring session.

Example:
"LoginToServer": true

UserName

String

optional

 This field contains a username for FTP authentication.

Example:
"UserName": "demo_username"

Password

String

optional

 This field contains a password for FTP authentication.

Example:
"Password": "demo_password"

Directory

String

optional

 This field specifies directory name which is going to be checked.

Example:
"Directory": "files"

GetDirectoryListing

Boolean

optional

 When enabled –files stored at a directory will be listed.

Example:
"GetDirectoryListing": true

CheckFile1

String

optional

 Availability of a filename specified in this file will be checked during monitoring.

Example:
"CheckFile1": "text.txt"

CheckFile2

String

optional

 Availability of a filename specified in this file will be checked during monitoring.

Example:
"CheckFile2": "picture.png"

CheckFile3

String

optional

 Availability of a filename specified in this file will be checked during monitoring.

Example:
"CheckFile3": "song.mp3"

DownloadFile

String

optional

 When filename specified – first 2Mbytes will be downloaded in order to check accessibility.

Example:
"DownloadFile": "text.txt"

Encription

String

optional

 The field value defines what method will be used during the monitoring session.

POSSIBLE VALUES:

  • Auto
  • None
  • TLS/SSL explicit
  • TLS/SSL implicit
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.
Device_Id

Int32

required

 READ ONLY Field. Unique device ID.

Example:
"Device_Id": 8550

Id

Int32

required

*Only for edit operations

 READ ONLY Field. Unique task id.

Example:
"Id": 17714

Task_Type_Id

Int32

required

 The type id of the task.

Example:
"Task_Type_Id": 16

Name

String

optional

 Task name.

Example:
"Name": "SFTP"

Timeout

Int32

optional

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

Example:
"Timeout": 0