v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

Market

SSL Certificates

Return provider's SSL certificate request status

This function returns the status of an SSL certificate request. The returns include actionable URLs for users to expedite the validation process, if applicable.

Important:

Because this function returns data from a dynamic source, the returns in each object can vary.

get/Market/get_certificate_status_details

Query parameters

order_item_idinteger required

Example:1234567890

The order ID that the cPanel Market provider assigned.

providerstring required

Example:cPStore

The cPanel Market provider's name.

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": "get_certificate_status_details",
  "module": "Market",
  "result": {
    "data": {
      "actionUrls": {
        "evClickThroughStatus": "https://example.com/action",
        "ovCallbackStatus": "https://example.com/action"
      },
      "domain_details": {
        "domain": "www.example.com",
        "status": "AWAITINGBRAND"
      },
      "status_details": {
        "brandValStatus": "in-progress",
        "certificateStatus": "in-progress",
        "csrStatus": "completed",
        "dcvStatus": "completed",
        "evClickThroughStatus": "in-progress",
        "freeDVUPStatus": "not applicable",
        "organizationValidationStatus": "not applicable",
        "ovCallbackStatus": "not applicable",
        "validationStatus": "in-progress"
      }
    },
    "messages": [
      "Certificate request is still being processed."
    ],
    "status": 1
  }
}