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.

Authorizations:

BasicAuth

query Parameters

order_item_id required	integer >= 1 The order ID that the cPanel Market provider assigned. Example: order_item_id=1234567890
provider required	string The cPanel Market provider's name. Example: provider=cPStore

Responses

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --user=username Market get_certificate_status_details order_item_id='1234567890' provider='cPStore'

Response samples

Content type

application/json

{"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"
}
},
"errors": null,
"messages": ["Certificate request is still being processed."
],
"metadata": { },
"status": 1,
"warnings": null
}
}

Next to Return provider's pending SSL certificates