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/
Query Examples:
The domains to check.
Note:
To check more than one domain, repeat or increment the parameter name. For example, domain-1, domain-2, and domain-3.
domain=domain-1=example.com&domain-2=example2.com&domain-3=example2.com
domain=example.com
An array of characters that the certificate provider allows in the DCV check file's filename.
Default ["A","B","C","D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z",0,1,2,3,4,5,6,7,8,9]
The DCV check file extension that the certificate provider requires.
Default ""
Example: dcv_file_extension=txt
The number of characters that the certificate provider allows in the DCV check file's filename.
Default 100
Example: dcv_file_random_character_count=32
The DCV check file's file path, relative to the domain's document root directory.
Default ".well-known/pki-validation"
Example: dcv_file_relative_path=.well-known/pki-validation
The number of domain redirects the system permits the DCV check to follow. The function checks the provider's supported number of redirects. It will then return the redirect array of objects for the passed value, plus one. This ensures the function will display any redirects causing DCV failures, if any exist.
Note:
- If you pass a
0value, this function does not limit the number of redirect returns. - Use the
Market::get_provider_specific_dcv_constraintsUAPI function to list a provider's supported number of redirects.
Default null
Example: dcv_max_redirects=2
The user agent string that the system uses for the imitated local DCV check.
Important:
The default value can change at any time.
Example: dcv_user_agent_string=SECTIGO+DCV
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/DCV/check_domains_via_http
- A server running cPanel.
https://cpanel-server.tld:2083/execute/DCV/check_domains_via_http
- 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/DCV/check_domains_via_http?domain=string&dcv_file_allowed_characters=A%2CB%2CC%2CD%2CE%2CF%2CG%2CH%2CI%2CJ%2CK%2CL%2CM%2CN%2CO%2CP%2CQ%2CR%2CS%2CT%2CU%2CV%2CW%2CX%2CY%2CZ%2C0%2C1%2C2%2C3%2C4%2C5%2C6%2C7%2C8%2C9&dcv_file_extension=txt&dcv_file_random_character_count=32&dcv_file_relative_path=.well-known%2Fpki-validation&dcv_max_redirects=2&dcv_user_agent_string=SECTIGO%2BDCV'Response
application/json
{ "apiversion": 3, "func": "check_domains_via_http", "module": "DCV", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Query Examples:
The domains to check.
Note:
To check multiple domains, duplicate or increment the parameter name. For example, domain-1, domain-2, and domain-3.
domain=domain-1=example1.com domain-2=example2.com domain-3=example3.com
domain=domain=example1.com domain=example2.com domain=example3.com
domain=example.com
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/DCV/ensure_domains_can_pass_dcv
- A server running cPanel.
https://cpanel-server.tld:2083/execute/DCV/ensure_domains_can_pass_dcv
- 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/DCV/ensure_domains_can_pass_dcv?domain=string'Response
application/json
{ "apiversion": 3, "func": "ensure_domains_can_pass_dcv", "module": "DCV", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }