Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function manually processes the cPanel Market's SSL certificate request pending queue.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Market/process_ssl_pending_queue

Note:

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

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Process the SSL pending queue.
$flush_twice = $cpanel->uapi(
    'Market', 'process_ssl_pending_queue'
);

Note:

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

 

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Process the SSL pending queue.
my $flush_twice = $cpliveapi->uapi(
    'Market', 'process_ssl_pending_queue'
);

Note:

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

 

 cPanel Template Toolkit
<!-- Process the SSL pending queue. -->
[% execute('Market', 'process_ssl_pending_queue') %]

Note:

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

 

 Command Line
uapi --user=username Market process_ssl_pending_queue

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. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{   
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{ 
      "transformed":1
   },
   "data": [
    {
        "certificate_pem": null,
        "created_time": "1460136406",
        "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIICqjCCAZICAQAwHDEaMBgGA1UEAxMRY3BhbmVsc3NsdGVzdC5vcmcwggEiMA0G\nCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCqu4KLPxCgAENTJFjcUyc4v5KaF8Lu\n2OldjIT/vB58IRCIUxdDSD29v/qHFVBaUFEtr+Ssey0strMcc6JYSl8Vdwfe2qwv\npB6+Ufg+hlN4lAgojxgwz7iZlPnGuRVfNTvNMmljVRzGDc4SSzskpDxZhk+aaMgP\nSkMLFg6f6pFZ+44alridlSG5gxD34xWAtt8Qy2v+6Q4XVuMNCd9KlyAoCV9Q+wH1\nq49yoRdwvcY6G6mqlFWtHsToz4tdYk/Nt7odZnyKcjHWGWnlRzO2FGbbBxVKF8s6\ns3DL5OwPRfQQD18V7eL7NmcFo45zmdndBOevrLuwXJ1yWITM2bmYgF1nAgMBAAGg\nSTBHBgkqhkiG9w0BCQ4xOjA4MDYGA1UdEQEB/wQsMCqCEWNwYW5lbHNzbHRlc3Qu\nb3JnghV3d3cuY3BhbmVsc3NsdGVzdC5vcmcwDQYJKoZIhvcNAQELBQADggEBAFAJ\nSqTvd3d8PN26UiT4uX0WjofaX8u1/11hU5Saekai0Dxl/ijq2R7TpebXe9r0t6Cr\ns7NXKszVoKzQHV4nSFbfb3ZxEsnVDXbPUv3D+oLfGpMASLG+P2yOjmDhzZBNJgo4\nQu6nf6ggJxJ0PRM81xL234FAKqsOvvTwTLXtYVrwbUCzfB+yKJXvfeGETR/3HGxR\nqoJ97Zmjsbw78fETEsZ6rsBHDPuxtxum73BC7qoLjCl4psPznHshXvWTeV9fyR3c\nqpdpLvwBxhI8ZOWoNGgJlUpY9jUFgqG+YI/Mkmzmxk9QC9edIHSScTXxroYkmwMC\nginnKRLDafSp+7FyIzs=\n-----END CERTIFICATE REQUEST-----",
        "deleted": 0,
        "domains": [
            "example.com"
        ],
        "first_poll_time": 1458061262,
        "installed": 0,
        "last_poll_time": 1458061299,
        "order_id": 19461,
        "order_item_id": "f9d7",
        "product_id": "fg2",
        "provider": "cPStore",
        "status": "confirmed",
        "vhost_names": [
            "example.com"
        ],
        "last_status_code": "CertificateNotFound",
        "expired": 0
    }
]

Note:

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

   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
 array of hashesInformation about each certificate request in the pending queue.This hash includes the certificate_pem, created_time, csr, deleted , first_poll_time, installed, last_poll_time, order_id, order_item_id , product_id, provider, status , last_status_code, and expired returns, and the domains and vhost_names arrays.  

certificate_pem

string

The text of the certificate, if available.

The function returns this value in the unnamed hash.

  • null — The certificate is not available.
  • A certificate file in Base64 PEM format.
null

created_time

integer

When the system placed the order.

The function returns this value in the unnamed hash.

A date in Unix time format.
1460136406
              

csr

string

The Certificate Signing Request's (CSR's) text.

The function returns this value in the unnamed hash.

A CSR file in Base64 PEM format.
 Click to view...
-----BEGIN CERTIFICATE REQUEST-----\nMIICqjCCAZICAQAwHDEaMBgGA1UEAxMRY3BhbmVsc3NsdGVzdC5vcmcwggEiMA0G\nCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCqu4KLPxCgAENTJFjcUyc4v5KaF8Lu\n2OldjIT/vB58IRCIUxdDSD29v/qHFVBaUFEtr+Ssey0strMcc6JYSl8Vdwfe2qwv\npB6+Ufg+hlN4lAgojxgwz7iZlPnGuRVfNTvNMmljVRzGDc4SSzskpDxZhk+aaMgP\nSkMLFg6f6pFZ+44alridlSG5gxD34xWAtt8Qy2v+6Q4XVuMNCd9KlyAoCV9Q+wH1\nq49yoRdwvcY6G6mqlFWtHsToz4tdYk/Nt7odZnyKcjHWGWnlRzO2FGbbBxVKF8s6\ns3DL5OwPRfQQD18V7eL7NmcFo45zmdndBOevrLuwXJ1yWITM2bmYgF1nAgMBAAGg\nSTBHBgkqhkiG9w0BCQ4xOjA4MDYGA1UdEQEB/wQsMCqCEWNwYW5lbHNzbHRlc3Qu\nb3JnghV3d3cuY3BhbmVsc3NsdGVzdC5vcmcwDQYJKoZIhvcNAQELBQADggEBAFAJ\nSqTvd3d8PN26UiT4uX0WjofaX8u1/11hU5Saekai0Dxl/ijq2R7TpebXe9r0t6Cr\ns7NXKszVoKzQHV4nSFbfb3ZxEsnVDXbPUv3D+oLfGpMASLG+P2yOjmDhzZBNJgo4\nQu6nf6ggJxJ0PRM81xL234FAKqsOvvTwTLXtYVrwbUCzfB+yKJXvfeGETR/3HGxR\nqoJ97Zmjsbw78fETEsZ6rsBHDPuxtxum73BC7qoLjCl4psPznHshXvWTeV9fyR3c\nqpdpLvwBxhI8ZOWoNGgJlUpY9jUFgqG+YI/Mkmzmxk9QC9edIHSScTXxroYkmwMC\nginnKRLDafSp+7FyIzs=\n-----END CERTIFICATE REQUEST-----
 

deleted

Boolean

Whether the system has deleted the item from the pending queue.

The functions returns this value in the unnamed hash.

  • 0 — Deleted.
  • 1Not deleted.
0

domains

array

An array of domains that the certificate request covers.

The function returns this array in the unnamed hash.

An array of valid domain names.
example.com

first_poll_time

string

The first time that the system polled the provider for the certificate.

The function returns this value in the unnamed hash.

A date in Unix time format.
1458061262
              

installed

Boolean

Whether the system installed the certificate.

The function returns this value in the unnamed hash.

  • 1 — Installed.
  • 0Not installed.
0
              

last_poll_time

string

The last time that the system polled the provider for the certificate.

The function returns this value in the unnamed hash.

A date in Unix time format.
1458061299
              

order_id

string

A unique identifier for the order.

The function returns this value in the unnamed hash.

A valid string.
19461
              

order_item_id

string

A unique identifier of each item in the order.

The function returns this value in the unnamed hash.

A valid string.
f9d7
              

product_id

string

An identifier for a given product.

The function returns this value in the unnamed hash.

A valid string.
fg2
              

provider

string

The cPanel Market provider's name.

The function returns this value in the unnamed hash.

A valid string.
cPStore

status

string

The status of the order.

The function returns this value in the unnamed hash.

  • confirmed — Payment confirmed.
  • unconfirmed — Payment not confirmed.
confirmed
              

vhost_names

array

An array of virtual host names.

The function returns this array in the unnamed hash.

An array of valid virtual host names.
example.com
              

last_status_code

string

The last status code of the order.

The function returns the value in the unnamed hash.

  • CertificateNotFound — The system cannot locate the specified certificate.
  • RequiresApproval — The specified certificate requires approval.
  • OrderCanceled — The system canceled the order of the specified certificate.
  • OrderItemCanceledThe system canceled the order item of the specified certificate.
CertificateNotFound

expired

Boolean

Whether the system has deleted the item from the pending queue.

The function returns the value in the unnamed hash.

  • 1 — Deleted.
  • 0Not deleted.
0