cPanel API 2 Functions - SSL::gencrt - Knowledgebase

Description

This function generates a self-signed certificate.

Warning:

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

SSL::generate_cert — This function generates a self-signed SSL certificate.

Note:

Use the SSL::listcrts function to retrieve the new certificate's information.

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=gencrt&city=

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Generate a self-signed certificate for example.com.
$generate_new_certificate = $cpanel->api2(
    'SSL', 'gencrt',
    array(
        'city'            => 'Houston',
        'company          => 'cPanel',
        'companydivision' => 'Documentation',
        'country'         => 'US',
        'email'           => 'user@example.com',
        'host'            => 'example.com',
        'state'           => 'TX',
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Generate a self-signed certificate for example.com.
my $generate_new_certificate = $cpliveapi->api2(
    'SSL', 'gencrt',
    {
        'city'            => 'Houston',
        'company          => 'cPanel',
        'companydivision' => 'Documentation',
        'country'         => 'US',
        'email'           => 'user@example.com',
        'host'            => 'example.com',
        'state'           => 'TX',
    }
);

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 fetchcabundle city=Houston company=cPanel companydivision=Documentation country=US email=username%40example.com host=example.com state=TX

Notes:

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

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "gencrt",
    "data": [
      {
        "output": "Certificate generated!",
        "result": 1
      }
    ],
    "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
city	string	Required The certificate owner's city.	The name of the city in which the certificate owner resides.	Houston
company	string	Required The certificate owner's company name.	The name of the certificate owner's company.	cPanel
companydivision	string	The certificate owner's division or department within the company. This parameter defaults to an empty string.	The name of the certificate owner's division or department.	Documentation
country	string	Required The certificate owner's country.	The country's two-letter abbreviation.	US
email	string	The certificate owner's email address. This parameter defaults to an empty string.	A valid email address.	user@example.com
host	string	Required The certificate's hostname.	A valid domain or subdomain name.	example.com
state	string	Required The certificate owner's state.	The state's two-letter abbreviation.	TX

Returns

Return	Type	Description	Possible values	Example
output	string	A message of success or a reason for failure.	Certificate generated! 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