GET api/FTPConfigurations?subLevels={subLevels}

Gets all FTP Configuration items

Request Information

URI Parameters

Name	Description	Type	Additional information
subLevels	Levels to include under this object, as applicable. -1 (the default) returns all sublevels.	integer	Default value is -1

Body Parameters

None.

Response Information

Resource Description

Information about all FTP Configurations the user can access

GetFTPConfigurationsResponse

Name	Description	Type	Additional information
FTPConfigurations	Array of FTP Configurations	Collection of FTPConfiguration	None.
Messages	Array of messages	Collection of Message	None.
ServerInformation	Relevant information regarding the Server	ServerInformation	None.
VersionInformation	Relevant information regarding the API's version	VersionInformation	None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "Messages": [
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    },
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    }
  ],
  "ServerInformation": {
    "CurrentTimeUTC": "2026-01-09T23:45:11.4892551+10:00",
    "BuildDateUTC": "2026-01-09T23:45:11.4892551+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  },
  "FTPConfigurations": [
    {
      "OwnerTypeName": "Device",
      "OwnerName": "sample string 1",
      "ProtocolName": "FTP",
      "IntervalName": "None",
      "FileFormatName": "CSV",
      "TimestampFormatName": "DateThenTime",
      "DateFormatName": "YearMonthDay",
      "TimeFormatName": "Time_24hr",
      "LastHandled": "2026-01-09T23:45:11.4892551+10:00",
      "Processing": true,
      "Valid": true,
      "ID": 3,
      "Name": "sample string 4",
      "Description": "sample string 5",
      "OwnerID": 1,
      "OwnerType": 10,
      "Protocol": 0,
      "Address": "sample string 6",
      "DestinationPath": "sample string 7",
      "Port": 1,
      "Interval": 0,
      "FileFormat": 0,
      "TimeZoneID": "sample string 8",
      "TimestampFormat": 0,
      "DateFormat": 0,
      "DateDelimiter": "A",
      "DateTimeSeparator": "A",
      "TimeFormat": 0,
      "TimeDelimiter": "A",
      "Devices": [
        {
          "ID": 1,
          "DeviceID": 1,
          "DeviceType": 10,
          "DeviceName": "sample string 2",
          "Field": "sample string 3",
          "Order": 1
        },
        {
          "ID": 1,
          "DeviceID": 1,
          "DeviceType": 10,
          "DeviceName": "sample string 2",
          "Field": "sample string 3",
          "Order": 1
        }
      ]
    },
    {
      "OwnerTypeName": "Device",
      "OwnerName": "sample string 1",
      "ProtocolName": "FTP",
      "IntervalName": "None",
      "FileFormatName": "CSV",
      "TimestampFormatName": "DateThenTime",
      "DateFormatName": "YearMonthDay",
      "TimeFormatName": "Time_24hr",
      "LastHandled": "2026-01-09T23:45:11.4892551+10:00",
      "Processing": true,
      "Valid": true,
      "ID": 3,
      "Name": "sample string 4",
      "Description": "sample string 5",
      "OwnerID": 1,
      "OwnerType": 10,
      "Protocol": 0,
      "Address": "sample string 6",
      "DestinationPath": "sample string 7",
      "Port": 1,
      "Interval": 0,
      "FileFormat": 0,
      "TimeZoneID": "sample string 8",
      "TimestampFormat": 0,
      "DateFormat": 0,
      "DateDelimiter": "A",
      "DateTimeSeparator": "A",
      "TimeFormat": 0,
      "TimeDelimiter": "A",
      "Devices": [
        {
          "ID": 1,
          "DeviceID": 1,
          "DeviceType": 10,
          "DeviceName": "sample string 2",
          "Field": "sample string 3",
          "Order": 1
        },
        {
          "ID": 1,
          "DeviceID": 1,
          "DeviceType": 10,
          "DeviceName": "sample string 2",
          "Field": "sample string 3",
          "Order": 1
        }
      ]
    }
  ]
}