Child pages
  • cPanel API 2 Functions - SSL::gencrt

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description


Excerpt
This function generates a self-signed certificate.


Warning
titleWarning:

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


Note
titleNote:

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

Multiexcerpt include
SpaceWithExcerptLIB
MultiExcerptName84APIDisabledUserSSLRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleWHM API (JSON)


Code Block
languagetext
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"

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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',
    ) 
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning


Expand
titleCommand Line


Code Block
languagebash
cpapi2 --user=username SSL gencrt city=Houston company=cPanel companydivision=Documentation country=US email=username%40example.com host=example.com state=TX

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "gencrt",
    "data": [
      {
        "output": "Certificate generated!",
        "result": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "SSL"
  }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


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