UAPI Functions - Market::process_ssl_pending_queue - Knowledgebase

Description

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

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Market/process_ssl_pending_queue

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'

);

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'

);

cPanel Template Toolkit

[% execute('Market', 'process_ssl_pending_queue') %]

Command Line

uapi --user=username Market process_ssl_pending_queue

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{ 
   "errors":null,
   "status":1,
   "messages":null,
   "metadata":{ 
      "transformed":1
   },
   "data":[ 
      { 
               "certificate_pem":null,
               "installed":0,
               "order_item_id":12345,
               "provider":"cPStore"
      }
   ]
}

Note:

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

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
	array of hashes	Information about each certificate in the pending queue.	This hash includes the certificate_pem,installed, order_item_id, polled, andprovider returns.
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
installed	Boolean	Whether the system installed the certificate as a result of this function. The function returns this value in the unnamed hash.	1 — Installed. 0 — Did not install.	1
order_item_id	string	The ID of the ordered item. The function returns this value in the unnamed hash.	A valid string.	12345
provider	string	The cPanel Market provider's name. The function returns this value in the unnamed hash.	A valid string.	cPStore

Knowledgebase

Categories

Categories