Skip to main content
Hitachi Vantara Knowledge

Update an FTP user

Update details for an existing FTP user.

HTTP request syntax (URI)
PATCH <base_URI>/v8/storage/ftp-users/{ftpUserObjectId}
Name Type Required Values Description
ftpUserObjectIdURI_PARAMYstringFTP user object ID
filesystemIdBODYNstringHNAS filesystem ID
initialDirectoryBODYNstringAbsolute file system path for when the FTP user initially connects – effectively the users home directory. The path should be in UNIX format.
ensurePathExistsBODYNbooleanTrue 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.
403Error MessageOperation 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" -X PATCH -d '{"initialDirectory":"/nigel", "ensurePathExists": true}'
Response example
HTTP/1.1 204 No Content


  • Was this article helpful?