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/Market/get_ssl_certificate_if_available
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Market/get_ssl_certificate_if_available
- 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/Market/get_ssl_certificate_if_available?order_item_id=8675309&provider=cPStore'Response
application/json
{ "apiversion": 3, "func": "get_ssl_certificate_if_available", "module": "Market", "result": { "data": { … }, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Market/process_ssl_pending_queue
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Market/process_ssl_pending_queue
- 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/Market/process_ssl_pending_queueResponse
application/json
{ "apiversion": 3, "func": "process_ssl_pending_queue", "module": "Market", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Query
The access token for the session to the cPanel Market provider.
Example: access_token=725431a1-d5bc-11e5-a28b-8b0e09a93f05
A JSON-encoded string that contains the details of the certificate.
Note:
To request multiple certificates, duplicate or increment the parameter name. For example, to request three certificates, use the certificate parameter multiple times or use the certificate-1, certificate-2, and certificate-3 parameters.
Example: certificate={"price":6,"product_id":"143","subject_names":[{"dNSName":"example.com"},{"dNSName":"example.org"}],"validity_period":["1, \"year\""],"vhost_names":["example.com"]}
An array of strings or array of objects containing the certificate's subject names:
For HTTP-based DCV only:
Use an array of strings that contains dNSName and the domain.
For example:
[["dNSName","example.com"],["dNSName","example.org"]]
DNS-based DCV or HTTP-based DCV:
Use an array of objects that consits of:
type:dNSNamename— The domain name.dcv_method— Either thednsorhttpvalue for for DNS-based or HTTP-based Domain Control Validation (DCV).
For example:
[{type:“dNSName”,name:“text.example.com”,dcv_method:“dns”},{type:“dNSName”,name:“text.example.com”,dcv_method:“http”}]
Note:
- Custom provider modules that include DNS-based DCV requests must use the array of objects format, not the array of strings format.
- This function does not automatically include the corresponding
www.subdomain for each domain that you declare in this parameter. - If you wish to order the
www.subdomain for a domain, you must explicitly declare it in an additional array or object within thesubject_namesparameter.
Example: [{"dNSName":"example.com"},{"dNSName":"example.org"}]
Any of:
An array of strings or array of objects containing the certificate's subject names:
For HTTP-based DCV only:
Use an array of strings that contains dNSName and the domain.
For example:
[["dNSName","example.com"],["dNSName","example.org"]]
DNS-based DCV or HTTP-based DCV:
Use an array of objects that consits of:
type:dNSNamename— The domain name.dcv_method— Either thednsorhttpvalue for for DNS-based or HTTP-based Domain Control Validation (DCV).
For example:
[{type:“dNSName”,name:“text.example.com”,dcv_method:“dns”},{type:“dNSName”,name:“text.example.com”,dcv_method:“http”}]
Note:
- Custom provider modules that include DNS-based DCV requests must use the array of objects format, not the array of strings format.
- This function does not automatically include the corresponding
www.subdomain for each domain that you declare in this parameter. - If you wish to order the
www.subdomain for a domain, you must explicitly declare it in an additional array or object within thesubject_namesparameter.
string
The period of time the certificate will remain valid. This array consists of a number value and string that represents a unit of time (for example, year).
Example: ["1, \"year\""]
An object containing the required information for an EV or OV certificate. This information depends on the provider of the certificate.
Note:
The function returns this object for OV or EV certificate requests.
Example: identity_verification={"countryName":"US","duns_number":"12-345-6789","localityName":"City Name","organizationName":"Company, Inc.","organizationalUnitName":"Team Company,","postalCode":55555,"rep_email_address":"username@example.com","rep_forename":"First Name","rep_surname":"Last Name","rep_telephone":"123-456-7891","stateOrProvinceName":"ST","streetAddress":"555 Street Name"}
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Market/request_ssl_certificates
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Market/request_ssl_certificates
- 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/Market/request_ssl_certificates?access_token=725431a1-d5bc-11e5-a28b-8b0e09a93f05&certificate={%22price%22%3A6%2C%22product_id%22%3A%22143%22%2C%22subject_names%22%3A%5B{%22dNSName%22%3A%22example.com%22}%2C{%22dNSName%22%3A%22example.org%22}%5D%2C%22validity_period%22%3A%5B%221%2C+%5C%22year%5C%22%22%5D%2C%22vhost_names%22%3A%5B%22example.com%22%5D}&provider=cPStore&identity_verification={%22countryName%22%3A%22US%22%2C%22duns_number%22%3A%2212-345-6789%22%2C%22localityName%22%3A%22City+Name%22%2C%22organizationName%22%3A%22Company%2C+Inc.%22%2C%22organizationalUnitName%22%3A%22Team+Company%2C%22%2C%22postalCode%22%3A55555%2C%22rep_email_address%22%3A%22username%40example.com%22%2C%22rep_forename%22%3A%22First+Name%22%2C%22rep_surname%22%3A%22Last+Name%22%2C%22rep_telephone%22%3A%22123-456-7891%22%2C%22stateOrProvinceName%22%3A%22ST%22%2C%22streetAddress%22%3A%22555+Street+Name%22}&url_after_checkout=http%3A%2F%2Fcheckout.example.com'Response
application/json
{ "apiversion": 3, "func": "request_ssl_certificates", "module": "Market", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }