DELETE api/v2/ftp

Removes a file specified by the request from an FTP server.

Request Information

URI Parameters

None.

Body Parameters

Delete File Request

SuiteBridge.Models.Ftp.FtpDeleteFileRequest
NameDescriptionTypeAdditional information
RemoteFile

The remote file or directory specified by RemoteFile is deleted. FileName is either an absolute path on the server, or a path relative to RemotePath.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "RemoteFile": "sample string 1"
}

application/xml, text/xml

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

status 200 OK on successful delete

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.