Child pages
  • UAPI Functions - Market::get_certificate_status_details
Skip to end of metadata
Go to start of metadata

Description

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

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Market/get_certificate_status_details?order_item_id=1234567890&provider=cPStore


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cPStore = new cPStore(); // Connect to cPStore - only do this once.
 
// Display the status of an SSL certificate.
$list_pending = $cPStore->uapi(
    'Market', 'get_certificate_status_details',
     array(
        'order_item_id' => '1234567890',
        'provider' => 'cPStore'
  )
);


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = cPStore::LiveAPI->new(); # Connect to cPStore - only do this once.
 
# Display the status of an SSL certificate.
my $list_pending = $cpliveapi->uapi(
    'Market', 'get_certificate_status_details', {
        'order_item_id' => '1234567890',
        'provider' => 'cPStore'
   }
);


Note:

For more information, read our Guide to the LiveAPI System.

 cPanel Template Toolkit
<!-- List pending SSL certificates. -->
[% execute('Market', 'get_certificate_status_details', { 'order_item_id' => '1234567890', 'provider' => 'cPStore' }) %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username Market get_certificate_status_details order_item_id=1234567890 provider=cPStore


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{  
   "data":{
      "actionUrls":{
         "ovCallbackStatus":"https://example.com/action",
         "evClickThroughStatus":"https://example.com/action"
      },
      "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"
      },
      "domain_details":{
         "domain":"www.example.com",
         "status":"AWAITINGBRAND"
      }
   },
   "error":"",
   "message":"Certificate request is still being processed"
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
order_item_idinteger

Required

The order ID that the cPanel Market provider assigned.

A positive integer.1234567890
providerstring

Required

The cPanel Market provider's name.

A valid string.cPStore

Returns

Note:

The following table provides example returns. However, because this function returns data from a dynamic source, the returns in each hash can vary.

ReturnTypeDescriptionPossible valuesExample
action_urlshashA hash that contains actionable URLs.This hash may include the ovCallbackStatus or evClickThroughStatus return.

ovCallbackStatus

string

A URL that a user can use to expedite the validation process for Organization Validated (OV) certificates.

This function returns this value in the action_urls hash.

A valid URL.

https://example.com/action


evClickThroughStatus

string

A URL that a user can use to expedite the validation process for Extended Validation (EV) certificates.

This function returns this value in the action_urls hash.

A valid URL.

https://example.com/action


status_detailshash

A hash that contains specific information about the validation process.

This hash may include the brandValStatus, certificateStatus, csrStatus, dcvStatus, evClickThroughStatus, freeDVUPStatus, organizationValidationStatus, ovCallbackStatus, or validationStatus returns.


brandValStatus

string

Whether the brand validation status has completed.

This function returns this value in the status_details hash.

  • not applicable
  • completed
  • in-progress

in-progress

certificateStatus

string

Whether the provider has issued the SSL certificate.

This function returns this value in the status_details hash.

  • not applicable
  • not-completed
  • completed
  • in-progress
in-progress

csrStatus

string

Whether the certificate signing request (CSR) has completed.

This function returns this value in the status_details hash.

  • not applicable
  • not-completed
  • completed
  • in-progress

completed

dcvStatus

string

Whether Domain Control Validation (DCV) has completed.

This function returns this value in the status_details hash.

  • not applicable
  • not-completed
  • completed
  • in-progresss
completed

evClickThroughStatus

string

Whether every requirement for the EV certificate has completed. For more information, read Comodo's What is required for validation? documentation.

This function returns this value in the status_details hash.

  • not applicable
  • not-completed
  • completed
  • in-progress

in-progress

freeDVUPStatus

string

Whether every requirement for the Domain Validated (DV) certificate has completed.

This function returns this value in the status_details hash.

  • not applicable
  • not-completed
  • completed
  • in-progress
not applicable

organizationValidationStatus

string

Whether every requirement for the OV certificate has completed.

This function returns this value in the status_details hash.

  • not applicable
  • not-completed
  • completed
  • in-progress

not applicable

ovCallbackStatus

string

Whether the Certificate Authority (CA) has verified the organization's validity via a phone call.

This function returns this value in the status_details hash.

  • not applicable
  • not-completed
  • completed
  • in-progress
not applicable


validationStatus

string

Whether the validation process has completed.

This function returns this value in the status_details hash.

  • not applicable
  • not-completed
  • completed
  • in-progress

in-progress

domain_details

hashA hash that contains information about the domain.

This hash may include the domain or status returns.


domain

string

The Fully Qualified Domain Name (FQDN) that the function queries.

This function returns this value in the domain_details hash.

A valid string.

www.example.com

status

string

The status of the domain's certificate.

This function returns this value in the domain_details hash.

  • VALIDATED
  • NOTVALIDATED
  • AWAITINGBRAND
AWAITINGBRAND