Update DNS config for a virtual server
Update DNS settings.
Specify a virtual server ID of 0 to ensure the global DNS settings are updated. If the virtual server specified has a global security context, then the global DNS settings will be updated, otherwise the DNS settings will be updated for the specified virtual server.
HTTP request syntax (URI)
PATCH <base_URI>/v8/storage/virtual-servers/{virtualServerId}/name-services/dns
Parameters
Name | Type | Required | Values | Description |
virtualServerId | URI_PARAM | Y | string/number | Specifies either the virtual server object ID or the HNAS storage virtual server ID. |
dnsServers | BODY | N | list of strings | List of IP addresses for DNS servers. |
dnsDomain | BODY | N | string | DNS domain. |
fileOnly | BODY | N | boolean | Whether to update only the file component of a Unified system. Default is False. |
searchOrder | BODY | N | list of strings | Specifies a list of DNS search domains, in the order they should be used. |
Return codes
Code | Data | Description |
204 | No Data | DNS 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
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/virtual-servers/0/name-services/dns -X PATCH -d '{"dnsServers":["10.1.2.3","10.1.2.4"], "dnsDomain":"example.com", "searchOrder":["one.example.com", "two.example.com", "three.example.com"]}'
Response example
HTTP/1.1 204 No Content