POST api/sftp/rename

renames a file specified by the request to an SFTP server.

Request Information

URI Parameters

None.

Body Parameters

Rename File Request

SuiteBridge.Models.Ftp.FtpRenameFileRequest
NameDescriptionTypeAdditional information
RemoteFile

The name of the remote file to rename and is either an absolute file path, or a relative path based on RemotePath

 string

None.
NewName

File New name

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "RemoteFile": "sample string 1",
  "NewName": "sample string 2"
}

application/xml, text/xml

Sample: 
<FtpRenameFileRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <RemoteFile>sample string 1</RemoteFile>
  <NewName>sample string 2</NewName>
</FtpRenameFileRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

status 200 OK on successful rename.

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.