JSON Object Example

{
    "Server": "ftp.nowhere.com",
    "LoginToServer": true,
    "UserName": "demo_username",
    "Password": "demo_password",
    "Directory": "files",
    "GetDirectoryListing": true,
    "CheckFile1": "text.txt",
    "CheckFile2": "",
    "CheckFile3": "",
    "DownloadFile": "text.txt",
    "RequireSSL": true,
    "DNSResolveMode": "Device Cached",
    "DNSserverIP": null,
    "Device_Id": 8550,
    "Id": 17714,
    "Task_Type_Id": 6,
    "Name": "FTP",
    "Timeout": 0
}

Fields description 

Field Type Description

Server

 String

FTP Server Address

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

LoginToServer

Boolean

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

Example:
"LoginToServer": true

UserName

String

This field contains a username for FTP authentication

Example:
"UserName": "demo_username"

Password

String

This field contains a password for FTP authentication

Example:
"Password": "demo_password"

Directory

String

This field specifies directory name which is going to be checked

Example:
"Directory": "files"

GetDirectoryListing

Boolean

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

Example:
"GetDirectoryListing": true

CheckFile1

String

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

Example:
"CheckFile1": "text.txt"

CheckFile2

String

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

Example:
"CheckFile2": "picture.png"

CheckFile3

String

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

Example:
"CheckFile3": "song.mp3"

DownloadFile

String

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

Example:
"DownloadFile": "text.txt"

RequireSSL

Boolean

When enabled – FTP over encrypted SSL protocol will be requested.

Example:
"RequireSSL": true
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
 

Int32

READ ONLY Field.Unique device ID

Example:
"Device_Id": 8550

Id

Int32

READ ONLY Field.Unique task id

Example:
"Id": 17714

Task_Type_Id

Int32

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

Example:
"Task_Type_Id": 6

Name

String

Task name

Example:
"Name": "FTP"

Timeout

Int32

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

Example:
"Timeout": 0