Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function lists the AutoSSL feature's log files.

Examples


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

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. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 Output (JSON)
{  
   "data":{  
      "payload":[  
         {  
			"in_progress":1,
            "provider":"cPanel",
			"start_time":"2016-06-09T13:58:13Z",
			"username":"username"
         },
         {  
			"in_progress":1,
            "provider":"cPanel",
			"start_time":"2016-06-09T13:59:04Z",
			"username":"username"
         },
         {  
			"in_progress":1,
            "provider":"cPanel",
			"start_time":"2016-06-09T14:10:01Z",
			"username":"username"
         },
         {  
			"in_progress":1,
            "provider":"cPanel",
			"start_time":"2016-06-09T14:25:37Z",
			"username":"username"
         }
      ]
   },
   "metadata":{  
      "reason":"OK",
      "command":"get_autossl_logs_catalog",
      "result":1,
      "version":1
   }
}
 Output (XML)
<result>
	<data>
		<payload>
			<in_progress>1</in_progress>
			<provider>cPanel</provider>
			<start_time>2016-06-09T13:58:13Z</start_time>
			<username>username</username>
		</payload>
		<payload>
			<in_progress>1</in_progress>
			<provider>cPanel</provider>
			<start_time>2016-06-09T13:59:04Z</start_time>
			<username>username</username>
		</payload>
		<payload>
			<in_progress>1</in_progress>
			<provider>cPanel</provider>
			<start_time>2016-06-09T14:10:01Z</start_time>
			<username>username</username>
		</payload>
		<payload>
			<in_progress>1</in_progress>
			<provider>cPanel</provider>
			<start_time>2016-06-09T14:25:37Z</start_time>
			<username>username</username>
		</payload>
	</data>
	<metadata>
		<reason>OK</reason>
		<command>get_autossl_logs_catalog</command>
		<result>1</result>
		<version>1</version>
	</metadata>
</result>

Note:

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

     

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
payloadarray of hashesAn array of hashes that contains information about an AutoSSL log file. This array of hashes includes the in_progress, provider, start_time, and username returns. 

in_progress

Boolean

Whether AutoSSL is in progress.

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

  • 1 — AutoSSL is in progress.
  • 0 — AutoSSL is not in progress.
1

provider

string

The AutoSSL provider's name. 

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

A valid AutoSSL provider's name. For example:

  • cPanel
  • LetsEncrypt
cPanel

start_time

string

When the system created the log file.

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

A time value, in ISO-8601 format.
2016-06-09T14:25:37Z

username

string

The user associated with the AutoSSL log entry.

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

The username of a cPanel user that the account owns.

* — Applies to all users.

username