Child pages
  • WHM API 1 Functions - get_autossl_pending_queue_for_domain
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

 

Description

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

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/get_autossl_pending_queue_for_domain?api.version=1&domain=example.com
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/get_autossl_pending_queue_for_domain?api.version=1&domain=example.com
 Command Line
whmapi1 get_autossl_pending_queue_for_domain domain=example.com


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{  
   "metadata":{  
      "reason":"OK",
      "command":"get_autossl_pending_queue_for_domain",
      "result":1,
      "version":1
   },
   "data":{  
      "queue_by_domain":[  
         {  
            "domain":"www.example.com",
			"last_poll_time":"2017-08-19T13:27:03Z",
            "order_item_id":12345678,
            "request_time":"2017-08-12T21:02:56Z",
		    "vhost_name":"example.com"
         },
         {  
            "domain":"mail.example.com",
			"last_poll_time":"2017-08-19T13:27:03Z",
            "order_item_id":123456780,
            "request_time":"2017-08-12T21:02:56Z",
		    "vhost_name":"example.com"
         }
      ]
   }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <result>1</result>
        <reason>OK</reason>
        <command>get_autossl_pending_queue_for_domain</command>
    </metadata>
	<data>
		<queue_by_domain>
			<domain>www.example.com</domain>
			<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>
		<queue_by_domain>
			<domain>mail.example.com</domain>
			<last_poll_time>2017-08-19T13:27:03Z</last_poll_time>
			<order_item_id>123456780</order_item_id>
			<request_time>2017-08-12T21:02:56Z</request_time>
			<vhost_name>example.com</vhost_name>
		</queue_by_domain>
	</data>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

 

Parameter
Type
Description
Possible values
Example
domainstring

Required

The domain for which to check the AutoSSL pending queue.

Note:

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 domain, last_poll_time, order_item_id, request_time, and vhost_name returns. 

domains

array

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
  • No labels