UAPI accesses the cPanel interface's features. Use this API to access and modify cPanel account data and settings.
Download OpenAPI description
Overview
URL
WebPros International, LLC
License
Languages
Servers
Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/
A server running cPanel.
https://{host}:{port}/execute/
Request
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.
Security
BasicAuth
Query
A valid temporary domain on the account.
Example: domain=wonderful-fushsia-owl.10-20-30-40.cpanel.site
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
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Domain/convert_temporary_to_registered
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Domain/convert_temporary_to_registered
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Domain/convert_temporary_to_registered?domain=wonderful-fushsia-owl.10-20-30-40.cpanel.site®istered=example.com&docroot=example.com'Response
application/json
{ "apiversion": 3, "func": "convert_temporary_to_registered", "module": "Domain", "result": { "data": { … }, "errors": null, "messages": null, "status": 1, "warnings": null } }
Request
This function determines whether a domain is temporary.
Note:
For more information about temporary domains, read our Temporary Domains documentation.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Domain/is_temporary_domain
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Domain/is_temporary_domain
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Domain/is_temporary_domain?domain=example.com'Response
application/json
{ "apiversion": 3, "func": "is_temporary_domain", "module": "Domain", "result": { "data": 1, "errors": null, "messages": null, "status": 1, "warnings": null } }
Request
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.
Security
BasicAuth
Query
A valid temporary domain on the account.
Example: domain=wonderful-fushsia-owl.10-20-30-40.cpanel.site
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
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Domain/convert_temporary_to_registered
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Domain/convert_temporary_to_registered
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Domain/convert_temporary_to_registered?domain=wonderful-fushsia-owl.10-20-30-40.cpanel.site®istered=example.com&docroot=example.com'Response
application/json
{ "apiversion": 3, "func": "convert_temporary_to_registered", "module": "Domain", "result": { "data": { … }, "errors": null, "messages": null, "status": 1, "warnings": null } }
Request
This function determines whether a domain is temporary.
Note:
For more information about temporary domains, read our Temporary Domains documentation.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Domain/is_temporary_domain
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Domain/is_temporary_domain
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Domain/is_temporary_domain?domain=example.com'Response
application/json
{ "apiversion": 3, "func": "is_temporary_domain", "module": "Domain", "result": { "data": 1, "errors": null, "messages": null, "status": 1, "warnings": null } }