Developer Documentation
Child pages
  • WHM API 1 Functions - get_autossl_pending_queue
Skip to end of metadata
Go to start of metadata

Guide to WHM API 1

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Call cPanel API 2 and UAPI


 cPanel Analytics

participate_in_analytics

 

Description

This function lists the items in the AutoSSL queue.

Examples

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


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",
      "result":1,
      "version":1
   },
   "data":{  
      "pending_certificates":[  
         {  
            "domain":"hostname.example.com",
            "virtual_host":"example.com",
            "order_item_id":8675309,
            "request_time":"2016-10-12T21:02:56Z",
            "user":"username"
			"dcv_method":"dns"
         },
         {  
            "domain":"mail.example.com",
            "virtual_host":"example.com",
            "order_item_id":8675308,
            "request_time":"2016-10-12T21:02:56Z",
            "user":"username"
			"dcv_method":"http"
         }
      ]
   }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <result>1</result>
        <reason>OK</reason>
        <command>get_autossl_pending_queue</command>
    </metadata>
    <data>
        <pending_certificates>
            <domain>hostname.example.com</domain>
            <virtual_host>example.com</virtual_host>
            <order_item_id>8675309</order_item_id>
            <request_time>2016-10-12T21:02:56Z</request_time>
            <user>username</user>
			<dcv_method>dns</dcv_method>
        </pending_certificates>
        <pending_certificates>
            <domain>mail.example.com</domain>
            <virtual_host>example.com</virtual_host>
            <order_item_id>8675308</order_item_id>
            <request_time>2016-10-12T21:02:56Z</request_time>
            <user>username</user>
			<dcv_method>http</dcv_method>
        </pending_certificates>
    </data>
</result>


Note:

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

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
pending_certificates
array of hashesAn array of hashes that contains information about each item in the AutoSSL queue.This array of hashes includes the domain, virtual_host, order_item_id, request_time, user, and dcv_method returns. 

domain

string

The domain's name.

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

A valid domain on the server.example.com

virtual_host

string

The virtual host that contains the domain.

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

A valid virtual host name.example.com

order_item_id

 string

The certificate's order item ID at the provider.

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

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

user

string

The owner of the cPanel account.

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

A valid cPanel username on the server.username

dcv_method

string

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.

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

  • http
  • dns
http

Function information

API Version:

WHM API 1

Available in:

WHM 62+

Methods:

GET, POST

Required Parameters:

(none)

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

  • Some functions and parameters may require that you authenticate as the root user.
  • You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.

Find a function

Related functions

 

cPanel, WebHost Manager, and WHM are registered trademarks of cPanel, L.L.C. for providing its computer software that facilitates the management and configuration of Internet web servers. ®2019 All rights reserved.