Sign in

v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Market
SSL Certificates

Request SSL certificate order

This function submits a request for a certificate order to the cPanel Market provider.

get/Market/request_ssl_certificates

Query parameters

access_tokenstring required
Example:725431a1-d5bc-11e5-a28b-8b0e09a93f05

The access token for the session to the cPanel Market provider.

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.

providerstring required
Example:cPStore

The cPanel Market provider's name.

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.

url_after_checkoutstring url
Example:http://checkout.example.com

The URL to send the browser after the user checks out.

Note:

This URL does not contain a query string.

Response

HTTP 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": "request_ssl_certificates",
  "module": "Market",
  "result": {
    "data": {
      "certificates": {
        "key_id": "ac90f_639fd_6c236062f0d7a4579a30e01612c4cee0",
        "order_item_id": 12345
      },
      "checkout_url": "http://store.example.com/showmethemoney.cgi",
      "order_id": 123456
    },
    "status": 1
  }
}