POST api/FTPConfigurations

Creates a new FTP Configuration

Request Information

URI Parameters

None.

Body Parameters

New FTP Configuration information

Name	Description	Type	Additional information
Username	Username credential to use	string	None.
Password	Password credential to use	string	None.
Name		string	None.
Description		string	None.
OwnerID		integer	None.
OwnerType		OwnerType	None.
Protocol		FTPProtocol	None.
Address		string	None.
DestinationPath		string	None.
Port		integer	None.
Interval		FTPInterval	None.
FileFormat		FTPFileFormat	None.
TimeZoneID		string	None.
TimestampFormat		FTPTimestampFormat	None.
DateFormat		FTPDateFormat	None.
DateDelimiter		character	None.
DateTimeSeparator		character	None.
TimeFormat		FTPTimeFormat	None.
TimeDelimiter		character	None.
Devices		Collection of Add_FTPConfigurationDevice	None.

Request Formats

application/json, text/json, text/html

Sample:

{
  "Username": "sample string 2",
  "Password": "sample string 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": [
    {
      "DeviceID": 1,
      "DeviceType": 10,
      "Field": "sample string 3",
      "Order": 1
    },
    {
      "DeviceID": 1,
      "DeviceType": 10,
      "Field": "sample string 3",
      "Order": 1
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Add_FTPConfiguration'.

Response Information

Resource Description

Information about the new FTP Configuration

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:52:05.4856808+10:00",
    "BuildDateUTC": "2026-01-09T23:52:05.4856808+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:52:05.4856808+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:52:05.4856808+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
        }
      ]
    }
  ]
}