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/
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/WebVhosts/list_domains
- A server running cPanel.
https://cpanel-server.tld:2083/execute/WebVhosts/list_domains
- 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/WebVhosts/list_domainsResponse
application/json
{ "apiversion": 3, "func": "list_domains", "module": "WebVhosts", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
This function lists every domain for which you may purchase an SSL certificate. The possible domains for the Secure Sockets Layer (SSL) certificate include applicable service subdomains.
Security
BasicAuth
Query
Whether to hide temporary domains from the returned values.
1— Return an error if the requested domain is a temporary domain.0— Return all domains, including the temporary domains. Note:
If you set this parameter's value to 1 and the requested domain is temporary, the function will return an error similar to the following example: Domain [example.com] is a temporary domain and hide_temporary_domains is enabled.
Default 0
Enum10
Example: hide_temporary_domains=1
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/WebVhosts/list_ssl_capable_domains
- A server running cPanel.
https://cpanel-server.tld:2083/execute/WebVhosts/list_ssl_capable_domains
- 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/WebVhosts/list_ssl_capable_domains?hide_temporary_domains=1'Response
application/json
{ "apiversion": 3, "func": "list_ssl_capable_domains", "module": "WebVhosts", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }