cPanel API 2 Functions - SSL::listcsrs - Knowledgebase

Description

This function lists the host domains for the account's Certificate Signing Requests (CSRs).

Warning:

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

SSL::list_csrs — This function lists an account's Certificate Signing Requests (CSR).

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=listcsrs

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Retrieve a list of CSRs.

$list_CSRs = $cpanel->api2(

'SSL', 'listcsrs'

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Retrieve a list of CSRs.

my $list_CSRs = $cpliveapi->api2(

'SSL', 'listcsrs',

);

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 listcsrs

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listcsrs",
    "data": [
      {
        "host": "example.com"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "SSL"
  }
}

Note:

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

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
host	string	A domain for which a CSR exists. Note: If no CSRs exist, the function succeeds withouthost output.	A domain on the cPanel account.	example.com
reason	string	A reason for failure.	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

Knowledgebase

Categories

Categories