Deletes a virtual server. A unique value identifies a virtual server to be deleted. You cannot delete an enabled virtual server.
HTTP request syntax (URI)
DELETE <base_URI>/v7/storage/virtual-servers/{id}
Parameters
Name | Type | Required | Values | Description |
---|---|---|---|---|
id | URI_PARAM | Y | string/number | Specifies either virtual server object ID or HNAS storage virtual server ID |
Return codes
Code | Data | Description |
---|---|---|
204 | No Data | Virtual server successfully deleted. |
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 virtual server object ID
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v7/storage/virtual-servers/333a3a3a4f49445f24232140255f56 -X DELETE
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/v7/storage/virtual-servers/15 -X DELETE
Response example: Using the HNAS storage virtual server ID
HTTP/1.1 204 No Content