cPanel API 2 Functions - SSL::listsslitems

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

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 — This function lists SSL-related items on a domain.

Note:

This function does not return a list of installed items.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

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:

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 include the --user=username option.
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

Parameter Type Description Possible values Example

Parameter	Type	Description	Possible values	Example
`domains`	string	Required The domain names.	One or more valid domain names. Separate multiple domains with the pipe character (`\|`). In WHM API calls, replace each pipe character with `%7C`.	`example.com\|seconddomain.com`
`items`	string	Required The SSL item types.	`key` — Search for installed keys. `crt` — Search for installed certificates. `csr` — Search for installed certificate signing requests (CSRs). Separate multiple types with the pipe character (`\|`). In WHM API calls, replace each pipe character with `%7C`.	`key\|crt\|csr`

domains

string

Required

The domain names.

One or more valid domain names.

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

example.com|seconddomain.com

items

string

Required

The SSL item types.

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

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

key|crt|csr

Returns

Return	Type	Description	Possible values	Example
`type`	string	The SSL item type.	`key` — The domain has at least one key installed. `crt` — The domain has at least one certificate installed. `csr` — The domain has at least one CSR installed.	`key`
`host`	string	The domain on which the SSL items are present.	A domain that you specified in the `domains` parameter.	`example.com`
`reason`	string	A reason for failure. This function only returns a `reason` value if there was an error.	A string that describes the error.	`This is an error message.`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`