v1

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

Create Dynamic DNS domain

This function creates a Dynamic DNS (DDNS) domain.

Important:

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

get/DynamicDNS/create

Query parameters

domainstring domain required
Example:home.example.com

The fully-qualified domain name to create as a DDNS domain.

descriptionstring
Example:Home network

A human-readable string that describes the domain.

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": "create",
  "module": "DynamicDNS",
  "result": {
    "data": {
      "id": "ggiugyxxjwnkmqtwysgmvrurplmafxpq"
    },
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}