cPanel API 2 Functions - SSL::listsslitems

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. 

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=

 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',
    )
);

 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',
    }
);

 cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use theLiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read ourDeprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.


 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.

 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 (Home >> Advanced >> API Shell) to directly test cPanel API calls.

 

   

Parameters

 Parameter 

Type

Description

Possible values

Example

domains

 string 

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 

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).

Notes:

  • 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 thedomains parameter.

example.com

reason

string

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. 

result

 Boolean 

Whether the function succeeded.

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

1

 

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....