Update Dynamic DNS domain description

This function sets the description on a user’s Dynamic DNS (DDNS) domain.

Important:

When you disable the DNS role, the system disables this function.

SecurityBasicAuth

Request

query Parameters

description required	string A human-readable string that describes the domain. Example: description=Home network
id required	string The DDNS domain’s ID. Example: id=ggiugyxxjwnkmqtwysgmvrurplmafxpq

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/DynamicDNS/set_description

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  DynamicDNS \
  set_description \
  id='ggiugyxxjwnkmqtwysgmvrurplmafxpq' \
  description='Home network'

Response samples

application/json

{"apiversion": 3,
"func": "list",
"module": "DynamicDNS",
"result": {"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}