Description

This function returns the most recent AutoSSL pending queue information for a specific domain.


Examples




https://hostname.example.com:2087/cpsess##########/json-api/get_autossl_pending_queue_for_domain?api.version=1&domain=example.com




https://hostname.example.com:2087/cpsess##########/xml-api/get_autossl_pending_queue_for_domain?api.version=1&domain=example.com




whmapi1 get_autossl_pending_queue_for_domain domain=example.com



{
   "data" : {
      "queue_by_domain" : [
         {
            "last_poll_time" : "2017-08-19T13:27:03Z",
            "domains" : [
               "example.com",
               "www.example.com"
            ],
            "dcv_methods" : [
               "http",
               "dns"
            ],
            "request_time" : "2017-08-12T21:02:56Z",
            "vhost_name" : "example.com",
            "order_item_id" : "12345678"
         }
      ]
   },
   "metadata" : {
      "version" : 1,
      "command" : "get_autossl_pending_queue_for_domain",
      "result" : 1,
      "reason" : "OK"
   }
}




<data>
  <queue_by_domain>
    <dcv_methods>http</dcv_methods>
    <dcv_methods>dns</dcv_methods>
    <domains>example.com</domains>
    <domains>www.example.com</domains>
    <last_poll_time>2017-08-19T13:27:03Z</last_poll_time>
    <order_item_id>12345678</order_item_id>
    <request_time>2017-08-12T21:02:56Z</request_time>
    <vhost_name>example.com</vhost_name>
  </queue_by_domain>
</data>
<metadata>
  <command>get_autossl_pending_queue_for_domain</command>
  <reason>OK</reason>
  <result>1</result>
  <version>1</version>
</metadata>



Parameters

Parameter
Type
Description
Possible values
Example
domainstring

Required

The domain for which to check the AutoSSL pending queue.

You can only enter one domain when you call this function. To check the most recent list of all AutoSSL queued domains that a user owns, read our get_autossl_pending_queue_for_user documentation.


A valid domain name that the account owns.example.com

Returns

ReturnTypeDescriptionPossible valuesExample
queue_by_domain
array of hashesAn array of hashes that contain information about the AutoSSL pending queue for the specific domain.This array of hashes includes the domains, last_poll_time, order_item_id, request_time, vhost_name, and dcv_methods returns. 

domains

array of strings

An array that contains information about the domains from the certificate's order_item_id parameter.

The function returns this array in the queue_by_domain 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 queue_by_domain array of hashes.

A time value, in ISO-8601 format.

2017-08-19T13:27:03Z

order_item_id

string

The provider's order item ID for the certificate.

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

A valid order item ID.

12345678

request_time

string

When AutoSSL made the request to the provider.

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

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

vhost_name

string

The virtual host that contains the domain.

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

A valid virtual host name.example.com

dcv_methods

array of strings

The methods of Domain Control Validation (DCV) that the system requested the Certificate Authority (CA) to perform for the given domains.


We introduced this return in cPanel & WHM version 74.

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

A comma-separated list that may contain http, dns, or both values.

This function returns the results from the domains parameter in the same order in which you called them.


http