POST api/filetransfer/sftp
Request Information
URI Parameters
None.
Body Parameters
SFTPFileParameters| Name | Description | Type | Additional information |
|---|---|---|---|
| host | string |
None. |
|
| port | integer |
None. |
|
| username | string |
None. |
|
| password | string |
None. |
|
| directory | string |
None. |
|
| file_name | string |
None. |
|
| file | Collection of byte |
None. |
|
| create_folder | boolean |
None. |
|
| folder_name | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"host": "sample string 1",
"port": 2,
"username": "sample string 3",
"password": "sample string 4",
"directory": "sample string 5",
"file_name": "sample string 6",
"file": "QEA=",
"create_folder": true,
"folder_name": "sample string 8"
}
application/xml, text/xml
Sample:
<SFTPFileParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.API.Controllers"> <create_folder>true</create_folder> <directory>sample string 5</directory> <file>QEA=</file> <file_name>sample string 6</file_name> <folder_name>sample string 8</folder_name> <host>sample string 1</host> <password>sample string 4</password> <port>2</port> <username>sample string 3</username> </SFTPFileParameters>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
JsonResultOfAPIResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Content | APIResponse |
None. |
|
| SerializerSettings | JsonSerializerSettings |
None. |
|
| Encoding | Encoding |
None. |
|
| Request | HttpRequestMessage |
None. |
Response Formats
application/json, text/json
Sample:
Sample not available.