Software Development Kit
cPanel & WHM's API [+] cPanel & WHM's API [-]Modules and Plugins [+] Modules and Plugins [-]
cPanel Modules
Writing cPanel Modules PHP Accounting Module cPanel::Accounting Perl Module Writing cPanel Plugins
Writing cPanel Plugins PHP in cPanel Plugin Interfaces cPanel CGI Scripts Live PHP in cPanel Plugins Plugin Variables Installing cPanel Plugins Adding Icons and Groups Plugin Installation File Generator Plugin Security Policy (
.pdf)
WHM Plugins
Creating WHM Plugins ACL Reference Table The swapip Utility cPanel Logger Module Pluggable dnsadmin Modules EasyApache Modules
Custom Modules?
cPanel & WHM Hooks [+] cPanel & WHM Hooks [-]
Standardized Hooks Introduction Taxonomy Getting Started Hooks Management Interface Hookable Events Advanced Usage Troubleshooting
Legacy Hooks Introduction Writing Function Hooks Script Hooks Custom Event Handlers cPanel Logger Module Universal Password Trap Hooking into EasyApache
EasyApache Hooks?
cPAddons (Site Software) [+] cPAddons (Site Software) [-]
System Administration [+] System Administration [-]
Developer Software [+] Developer Software [-]
Back to All Documentation
SSLInfo Module Documentation
The SSLInfo module allows users to get information about SSL certificates. The functions within this module may or may not be governed by a feature list. The required feature list may vary from function to function, to review a total list of the available features sets on a cPanel server, please see "Feature Manager" in WHM.SSLInfo::fetchinfo
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Retrieve an SSL certificate, private key, and related CA bundle for a specified domain. This function will also display the domain's owner and the IP address to which the name is bound. To use this function, you will only need to specify 1 of the following 2 parameters. The domain parameter will take precedence if both are used. |
| Parameters: | |
| crtdata (string (optional)) | |
| The contents of the SSL certificate. cPanel will decode the certificate in order to find its corresponding domain. Only certificates can be used. You cannot use a key, CA bundle, or CSR as this parameter's input. | |
| domain (string (optional)) | |
| The domain whose SSL certificate, private key, and CA bundle you wish to retrieve. | |
| Returns: | |
<data> <domain> A string value that contains the domain that corresponds to the certificate.</domain> <statusmsg> A string value that contains 'ok' if the request was successful. This value will contain an error message if the request was not successful.</statusmsg> <status> A boolean value indicating success or failure. '1' if the request completed successfully.</status> <ip> A string value that contains the IP address to which the domain is bound.</ip> <user> A string value that contains the owner of the domain.</user> <crt> A string value that contains the contents of the SSL certificate, if the request was completed successfully. Otherwise, this value will contain an error message.</crt> <cab> A string value that contains the contents of CA bundle. If the CA bundle does not exist, this value will be an empty hashref (e.g. '{}').</cab> <key> A string value that contains the key file associated with the certificate, if the request was completed successfully. Otherwise, this value will contain an error message.</key> </data> |
Edit | Attach | Print version | History: r2 < r1 | Backlinks | Raw View | More topic actions
Topic revision: r2 - 27 Mar 2012 - 16:44:25 - Main.JenniferDoubrava