Update an FTP user
Update details for an existing FTP user.
HTTP request syntax (URI)
PATCH <base_URI>/v8/storage/ftp-users/{ftpUserObjectId}
Parameters
| Name | Type | Required | Values | Description |
| ftpUserObjectId | URI_PARAM | Y | string | FTP user object ID |
| filesystemId | BODY | N | string | HNAS filesystem ID |
| initialDirectory | BODY | N | string | Absolute file system path for when the FTP user initially connects – effectively the users home directory. The path should be in UNIX format. |
| ensurePathExists | BODY | N | boolean | True to ensure the specified path exists. Default false. |
Return codes
| Code | Data | Description |
| 204 | No Data | FTP logging config successfully updated. |
| 400 | Error Message | Missing or invalid request contents. |
| 403 | Error Message | Operation forbidden by access level. |
| 404 | Error Message | Requested resource not found. |
| 500 | Error message | Error associated with the storage system. |
Any HTTP status code other than 204 indicates that the API did not complete successfully.
Request example: Change the initial directory and ensure that it exists
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/ftp-users/313a3a3a64617272656e3a3a3a303a3a3a4f49445f24232140255f56 -X PATCH -d '{"initialDirectory":"/nigel", "ensurePathExists": true}'
Response example
HTTP/1.1 204 No Content