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.
SecurityBasicAuth
Request
query Parameters
domain
required
string <domain>

A valid temporary domain on the account.

Example: domain=wonderful-fushsia-owl.10-20-30-40.cpanel.site
registered
required
string <domain>

A valid domain name.

Example: registered=example.com
docroot
string

The path to the domain's document root directory. If you do not specify a value, this parameter defaults to the domain's name.

Note:

The function will create a symlink in place of the previous temporary domain's document root directory. The symlink will point to the registered domain's document root.

Example: docroot=example.com
Responses
200

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
post/Domain/convert_temporary_to_registered
Request samples
uapi --output=jsonpretty \
  --user=username \
  Domain \
  convert_temporary_to_registered \
  domain=wonderful-fushsia-owl.10-20-30-40.cpanel.site \
  registered=example.com
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "convert_temporary_to_registered",
  • "module": "Domain",
  • "result": {
    • "data": {
      • "message": "Domain wonderful-fushsia-owl.10-20-30-40.cpanel.site successfully converted to example.com"
      },
    • "errors": null,
    • "messages": null,
    • "status": 1,
    • "warnings": null
    }
}