v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Domain
Temporary Domains

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.
post/Domain/convert_temporary_to_registered

Query parameters

domainstring domain required
Example:wonderful-fushsia-owl.10-20-30-40.cpanel.site

A valid temporary domain on the account.

registeredstring domain required
Example:example.com

A valid domain name.

docrootstring
Example:example.com

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.

Response

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": "convert_temporary_to_registered",
  "module": "Domain",
  "result": {
    "data": {
      "message": "Domain wonderful-fushsia-owl.10-20-30-40.cpanel.site successfully converted to example.com"
    },
    "status": 1
  }
}