Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function lists the AutoSSL feature's log files.

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/get_autossl_logs_catalog?api.version=1
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/get_autossl_logs_catalog?api.version=1
Expand
titleCommand Line
Code Block
languagebash
whmapi1 get_autossl_logs_catalog

Include Page
_WHMAPI1CLINote
_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{  
   "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
   }
}
Expand
titleOutput (XML)
Code Block
languagetext
linenumberstrue
<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>

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

     

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