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

 

Description

This function lists the items in the AutoSSL queue.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/SSL/get_autossl_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.
 
// List the items in the AutoSSL queue.
$SSL_get_autossl_pending_queue = $cpanel->uapi(
    'SSL', 'get_autossl_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.
 
#  List the items in the AutoSSL queue.
my $SSL_get_autossl_pending_queue = $cpliveapi->uapi(
    'SSL', 'get_autossl_pending_queue'
);

Note:

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

 cPanel Template Toolkit
<!-- List the items in the AutoSSL queue. -->
[% data = execute( 'SSL', 'get_autossl_pending_queue'); %]
[% FOREACH q = data %]
     <p>
         [% q %]
     </p>
[% END %]

Note:

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

 Command Line
uapi --user=username SSL get_autossl_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,
 "data":[
		 {
            "domain":"www.example.com",
            "last_poll_time":"2017-08-22T05:38:07Z",
            "order_item_id":8675309,
            "request_time":"2016-10-12T21:02:56Z",
            "vhost_name":"example.com"

         },
         { 
            "domain":"mail.example.com",
            "last_poll_time":"2017-08-22T05:38:07Z",
            "order_item_id":8675309,
            "request_time":"2016-10-12T21:02:56Z",
            "vhost_name":"example.com"
         }
	]
}

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
data
array of hashesAn array of hashes that contain information about each item in the AutoSSL queue.This array of hashes includes the domain, last_poll_time, order_item_id, request_time, and vhost_name returns. 

domain

string

The domain's name.

The function returns this value in the data array of hashes.

A valid domain on the server.www.example.com

last_poll_time

string

The time of the most recent poll of the provider for the DCV status.

The function returns this value in the data array of hashes.

A time value, in ISO-8601 format.

2016-10-19T13:27:03Z

order_item_id

string

The provider's order item ID for the certificate.

The function returns this value in the data array of hashes.

A valid string.8675309

request_time

integer

When AutoSSL made the request to the provider.

The function returns this value in the data array of hashes.

A time value, in ISO-8601 format.
2016-10-12T21:02:56Z

vhost_name

string

The virtual host that contains the domain.

The function returns this value in the data array of hashes.

A valid virtual host name.example.com