- Created by Documentation, last modified on Jun 25, 2018
disable_authentication_provider
disable_failing_authentication_providers
enable_authentication_provider
get_available_authentication_providers
get_provider_client_configurations
get_provider_configuration_fields
get_provider_display_configurations
get_users_authn_linked_accounts
set_provider_client_configurations
set_provider_display_configurations
twofactorauth_generate_tfa_config
twofactorauth_get_user_configs
cpgreylist_is_server_netblock_trusted
cpgreylist_list_entries_for_common_mail_provider
cpgreylist_load_common_mail_providers_config
cpgreylist_save_common_mail_providers_config
cpgreylist_trust_entries_for_common_mail_provider
cpgreylist_untrust_entries_for_common_mail_provider
create_cpgreylist_trusted_host
delete_cpgreylist_trusted_host
Description
This function lists the items in the AutoSSL queue.
Examples
https://hostname.example.com:2087/cpsess##########/json-api/get_autossl_pending_queue?api.version=1
https://hostname.example.com:2087/cpsess##########/xml-api/get_autossl_pending_queue?api.version=1
whmapi1 get_autossl_pending_queue
Notes:
- 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
{ "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" } ] } }
<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:
Parameters
This function does not accept parameters.
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
pending_certificates | array of hashes | An 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. | |
| string | The domain's name. The function returns this value in the | A valid domain on the server. | example.com |
| string | The virtual host that contains the domain. The function returns this value in the | A valid virtual host name. | example.com |
| string | The certificate's order item ID at the provider. The function returns this value in the | A valid string. | 8675309 |
| integer | When AutoSSL made the request to the provider. The function returns this value in the | A time value, in ISO-8601 format. | 2016-10-12T21:02:56Z |
| string | The owner of the cPanel account. The function returns this value in the | A valid cPanel username on the server. | username |
| 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 |
| http |
Function information
API Version:
Available in:
WHM 62+
Methods:
GET, POST
Required Parameters:
(none)
Return Formats:
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
or2087
) to call WHM API functions.
Find a function
Related functions
-
Page:WHM API 1 Functions - is_sni_supported — This function checks whether the server supports SNI (Server Name Indication).
-
Page:WHM API 1 Sections - Security — Security functions allow you to manage system security services.
-
Page:WHM API 1 Functions - authorizesshkey — This function authorizes a key to access the server via SSH.
-
Page:WHM API 1 Functions - check_remote_ssh_connection — This function tests an SSH connection to another server.
-
Page:WHM API 1 Functions - convertopensshtoputty — This function converts an OpenSSH private key to a PuTTY key.