We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Child pages
  • UAPI Functions - SSL::get_autossl_pending_queue
Skip to end of metadata
Go to start of metadata

Description

This function lists the items in the AutoSSL queue.

Important:

In cPanel & WHM version 84 and later, when you disable the Calendars and Contacts, Receive Mail, Web DiskWebmail, and Web Server roles, the system disables this function.

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.

 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. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
	"module": "SSL",
	"func": "get_autossl_pending_queue",
	"apiversion": 3,
	"result": {
		"status": 1,
		"warnings": null,
		"metadata": {
			"transformed": 1
		},
		"messages": null,
		"data": [{
			"last_poll_time": "2019-12-12T21:06:53Z",
			"domain": "example.com",
			"request_time": "2016-10-12T21:02:56Z",
			"dcv_methods": [
				"http"
			],
			"order_item_id": "8675308",
			"vhost_name": "example.com"
		}],
		"errors": null
	}
}


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

domain

string

The domain's name.

A valid domain on the server.example.com

vhost_name

string

The virtual host that contains the domain.

A valid virtual host name.example.com

order_item_id

string

The certificate's order item ID at the provider.

A valid string.8675309

request_time

integer

When AutoSSL made the request to the provider.

A time value, in ISO-8601 format.

2016-10-12T21:02:56Z

last_poll_time 

integer

The most recent time that the system checked the AutoSSL certificate status.

A time value, in ISO-8601 format.2019-12-12T21:06:53Z

dcv_method

array of strings

The method of Domain Control Validation (DCV) that the system requested the Certificate Authority (CA) to perform for this domain.

Note:

We introduced this return in cPanel & WHM version 74.

  • http
  • dns
http