cPanel module

Domain

3 functions, invoked through the cpanel_uapi tool.

scope cpanel:uapi

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

convert_temporary_to_registered POST#

Convert a temporary domain to a registered domain

This function converts a temporary domain into a registered domain and moves its document root files to the new document root location.

Note:

For more information about temporary domains, read our Temporary Domains documentation.
You cannot use this function to convert a cPanel account's main domain.

No parameters.

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

messagestring

A message describing the result of the conversion.

is_temporary_domain GET#

Return whether a domain is temporary

This function determines whether a domain is temporary.

Note:

For more information about temporary domains, read our Temporary Domains documentation.

domainstringRequired

A domain on the cPanel account.

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

Whether the domain is a temporary domain. 1 - The domain is a temporary domain. 0 - The domains is not a temporary domain.

temporary_domain_is_disabled GET#

Return whether temporary domains are disabled

This function returns whether the temporary domains feature is disabled by server configuration.

Note:

For more information about temporary domains, read our Temporary Domains documentation.

No parameters.

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

is_disabledinteger

Whether temporary domains are disabled by server configuration. 1 - Temporary domains are disabled. 0 - Temporary domains are enabled.

One of: 0 1