Child pages
  • cPanel API 1 Functions - SSL::gencsr
Skip to end of metadata
Go to start of metadata

Description


This function generates a certificate signing request (CSR).

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

  • UAPI (recommended)SSL::generate_csr
    Error rendering macro 'excerpt-include' : No link could be created for 'UAPI Functions - SSL::generate_csr'.
  • cPanel API 2SSL::gencsr
    Error rendering macro 'excerpt-include' : No link could be created for 'cPanel API 2 Functions - SSL::gencsr'.

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$ssl_csr = $cpanel->api1('SSL','gencsr', array('hostname.example.com','us','Texas','Houston','The Example Company','Widget Production','user@example.com','12345luggage') ); // Call the function.


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.
my $ssl_csr = $cpliveapi->api1('SSL','gencsr', ['hostname.example.com','us','Texas','Houston','The Example Company','Widget Production','user@example.com','12345luggage'] ); # Call the function.


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 provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="SSL::gencsr( $FORM('host','country','state','city','co','cod','email','pass') )">
 Command Line
cpapi1 --user=username SSL gencsr hostname.example.com us Texas Houston "The Example Company" "Widget Production" user@example.com 12345luggage


Notes:

  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi1 command:

    /usr/local/cpanel/bin/cpapi1

 Output (none)

This function does not return output.

Parameters

ParameterTypeDescriptionPossible valuesExample
host

string

Required

The hostname.

A fully-qualified domain name.hostname.example.com
countrystring

Required

The certificate owner's country.

A valid ISO-3166 two-letter country code.US
statestring

Required

The certificate owner's state.

The full name of the state.

Note:

Do not abbreviate this parameter. Use the full name of the state.

Texas
citystring

Required

The certificate owner's city.

The full name of the city.Houston
costring

Required

The certificate owner's company name.

A valid string.The Example Company
codstring

The certificate owner's company division.

This parameter defaults to an empty string.

A valid string.Widget Production
emailstring

Required

The email address for the certificate.

A valid email address.username@example.com
passstring

The password that will correspond to the certificate.

This parameter defaults to an empty string.

A valid string.12345luggage

Returns

This function does not return output. The system writes the CSR to the user's ~ssl/private directory,