Child pages
  • cPanel API 2 Functions - SSL::listsslitems
Skip to end of metadata
Go to start of metadata

Description


This function lists the types of the account's installed SSL items.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

  • SSL::list_ssl_items

    Error rendering macro 'excerpt-include' : No link could be created for 'UAPI Functions - SSL::list_ssl_items'.

Note:

This function does not return a list of installed items. 

Examples 


 WHM API (JSON)
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=SSL&cpanel_jsonapi_func=listsslitems&domains="example.com%7Cseconddomain.com"&items="key%7Ccrt%7Ccsr"


Note:

 For more information, read our Calls from the WHM API documentation.

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List SSL item types for example.com and seconddomain.com.
$list_ssl_item_types = $cpanel->api2(
    'SSL', 'listsslitems', 
    array(
        'domains'         => 'example.com|seconddomain.com',
        'items'           => 'key|crt|csr',
    ) 
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List SSL item types for example.com and seconddomain.com.
my $list_ssl_item_types = $cpliveapi->api2(
    'SSL', 'listsslitems',
    {
        'domains'         => 'example.com|seconddomain.com',
        'items'           => 'key|crt|csr',
    }
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Tag System (deprecated)


Warnings:

  • In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

 Command Line
cpapi2 --user=username SSL listsslitems domains=example.com%7Cseconddomain.com items=key%7Ccrt%7Ccsr


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    /usr/local/cpanel/bin/cpapi2

 Output (JSON)
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listsslitems",
    "data": [
      {
        "type": "key",
        "host": "example.com"
      },
      {
        "type": "crt",
        "host": "example.com"
      },
      {
        "type": "csr",
        "host": "example.com"
      },
      {
        "type": "key",
        "host": "seconddomain.com"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "SSL"
  }
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
domainsstring

Required

The domain names.

One or more valid domain names.

Notes:

  • Separate multiple domains with the pipe character (|).
  • In WHM API calls, replace each pipe character with %7C.
example.com|seconddomain.com
itemsstring

Required

The SSL item types.

  • key — Search for installed keys.
  • crt — Search for installed certificates.
  • csr — Search for installed certificate signing requests (CSRs).

Notes:

  • Separate multiple types with the pipe character ( | ).
  • In WHM API calls, replace each pipe character with %7C.
key|crt|csr

Returns

ReturnTypeDescriptionPossible valuesExample
typestringThe SSL item type.
  • key — The domain has at least one key installed.
  • crtThe domain has at least one certificate installed.
  • csrThe domain has at least one CSR installed.
key
hoststringThe domain on which the SSL items are present.

A domain that you specified in the domains parameter.

example.com
reasonstring

A reason for failure.

Note:

This function only returns a reason value if there was an error. 


A string that describes the error. This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1