Rename a file system

NAS File Storage REST API v7 Reference

Version
14.7.x
14.6.x
Audience
anonymous
Part Number
MK-92HNAS088-05

Renames a file system. Also, you can rename the file system by changing the label associated with the file system.

HTTP request syntax (URI)

PATCH <base_URI>/v7/storage/filesystems/{id}

Parameters

Name Type Required Values Description
id URI_PARAM Y string Specifies either the file system object ID or the HNAS storage file system ID.
label BODY Y string The new label for the file system.

Return codes

Code Data Description
204 No Data File system successfully renamed.
400 No Data Missing or invalid request contents.
404 Error Message Requested resource not found.
500 Error message Error associated with the storage system.
501 No Data Server has not implemented the request operation on the resource.

Any HTTP status code other than 204 indicates that the API did not complete successfully.

Request example: Using the file system object ID

curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v7/storage/filesystems/3836363236374331323541433731414230303030303030303030303030303030 –d '{"label":"TestFS"}' -X PATCH

Response example: Using the file system object ID

HTTP/1.1 204 No Content

Request example: Using the HNAS storage file system ID

curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v7/storage/filesystems/8659E4DE8E2FF4EA0000000000000000 –d '{"label":"TestFS"}' -X PATCH

Response example: Using the HNAS storage file system ID

HTTP/1.1 204 No Content