cPanel/DynamicDNS
cPanel module

DynamicDNS

5 functions, invoked through the cpanel_uapi tool.

scope cpanel:uapi
Call any function with cpanel_uapi(service_id, module="DynamicDNS", function, params). Live availability depends on the cPanel features JetHost has enabled on your account — call list_cpanel_operations to see what is active.

create GET#

Create Dynamic DNS domain

This function creates a Dynamic DNS (DDNS) domain.

Important:

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

domainstringRequired
The fully-qualified domain name to create as a DDNS domain.
descriptionstringOptional
A human-readable string that describes the domain.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

created_timeinteger
The creation time of the Dynamic DNS domain.
idstring
The DDNS domain’s ID.

delete GET#

Delete Dynamic DNS domain

This function deletes an existing Dynamic DNS (DDNS) domain.

Important:

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

idstringRequired
The DDNS domain’s ID.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

deletednumber
Whether a DDNS domain with the given ID existed for deletion. 0 - No DDNS domain with the given ID existed. 1 - A DDNS domain with the given ID existed but is now deleted.
One of: 0 1

list GET#

Return Dynamic DNS domains

This function lists the user’s Dynamic DNS (DDNS) domains.

Important:

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

No parameters.

Response — normalized as { ok, data, errors[], warnings[] }; data is an array of:

created_timeinteger
The DDNS domain’s creation time.
descriptionstring
A user-editable string that describes the DDNS domain.
domainstring
The domain.
idstring
The domain’s DDNS ID. Note: This ID goes into the URL that the client uses to update the domain’s IP address resolution.
last_run_timesarray<integer>
The most recent times when the web call ran. Note: This list changes every time the web call runs, even if the domain’s IP address resolution does not change.
last_update_timeinteger
The most recent update time for the DDNS domain. Note: This value changes only when the domain’s IP address resolution changes.

recreate GET#

Update Dynamic DNS domain ID

This function gives a new, randomly-generated ID to an existing Dynamic DNS (DDNS) domain.

Important:

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

idstringRequired
The DDNS domain’s ID.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

idstring
The DDNS domain’s new ID.

set_description GET#

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.

descriptionstringRequired
A human-readable string that describes the domain.
idstringRequired
The DDNS domain’s ID.