Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function generates a self-signed certificate.

Warning:

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

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="Houston"&company="cPanel"&companydivision="Documentation"&country="US"&email="user@example.com"&host="example.com"&state="TX"

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

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

Note:

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

 cPanel Tag System (deprecated)

Warning:

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.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated 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 gencrt 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.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

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

Parameters

ParameterTypeDescriptionPossible valuesExample
citystring

Required

The certificate owner's city.

The name of the city in which the certificate owner resides.Houston
companystring

Required

The certificate owner's company name.

The name of the certificate owner's company.cPanel
companydivisionstring

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
countrystring

Required

The certificate owner's country.

The country's two-letter abbreviation.US
emailstring

The certificate owner's email address.

This parameter defaults to an empty string.

A valid email address.user@example.com
hoststring

Required

The certificate's hostname.

A valid domain or subdomain name.

 

example.com
statestring

Required

The certificate owner's state.

The state's two-letter abbreviation.TX

Returns

ReturnTypeDescriptionPossible valuesExample
outputstring

A message of success or a reason for failure.

  • Certificate generated!
  • 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