v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
DynamicDNS
Dynamic DNS

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.

get/DynamicDNS/set_description

Query parameters

descriptionstring required
Example:Home network

A human-readable string that describes the domain.

idstring required
Example:ggiugyxxjwnkmqtwysgmvrurplmafxpq

The DDNS domain’s ID.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

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