Rename a virtual server
Renames a virtual server. A unique value renames the virtual server.
HTTP request syntax (URI)
PATCH <base_URI>/v8/storage/virtual-servers/{virtualServerId}
Parameters
| Name | Type | Required | Values | Description |
| virtualServerId | URI_PARAM | Y | string/number | Specifies either virtual server object ID or HNAS storage virtual server ID. |
| name | BODY | Y | string | New name for the virtual server. |
Return codes
| Code | Data | Description |
| 204 | No Data | Virtual server was successfully renamed. |
| 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: Using the virtual server object ID
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/virtual-servers/313a3a3a4f49445f24232140255f56 -d '{"name":"testing1"}' -X PATCH
Response example: Using the virtual server object ID
HTTP/1.1 204 No Content
Request example: Using the HNAS storage virtual server ID
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/virtual-servers/8 -d '{"name":"testing1"}' -X PATCH
Response example: Using the HNAS storage virtual server ID
HTTP/1.1 204 No Content