FtpsiteResource

The following resources are part of this group:

/ftpsites/{ftpsite}

The following operations are supported on this resource:

GET

Return a specific FTP site.

Successful Response Content

  1. ftpsite

HTTP Status code: OK - 200

Failure Response Content

  1. fault

HTTP Status code: error status code

Parameters

name description type default
ftpsite FTP site to retrieve path

Response Body

element: (custom)

Return a specific FTP site or a fault document.

DELETE

Deletes a specific FTP site.

Successful Response Content: No Content

HTTP Status code: No Content - 204

Failure Response Content

  1. fault

HTTP Status code: error status code

Parameters

name description type default
ftpsite FTP site to delete path
ignoreCheck Ignore FTP site validation checks query true

Response Body

element: (custom)

Return no content or a fault document.

POST

Update an existing FTP site.

Successful Response Content

  1. ftpsite

HTTP Status code: OK - 200

Failure Response Content

  1. fault

HTTP Status code: error status code

Parameters

name description type default
ftpsite FTP site name to update path
ignoreCheck Ignore FTP site validation checks query false

Request Body

element: ftpsite

Exiting FTP site to update

Response Body

element: (custom)

Updated user or a fault document.