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

Description

This function generates an SSL key for a host.

Warning:

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

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$ssl_key = $cpanel->api1('SSL','genkey', array('hostname.example.com','1024') ); // 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_key = $cpliveapi->api1('SSL','genkey', ['hostname.example.com','1024'] ); # 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::genkey( $FORM('host','keysize') )">
 Command Line
cpapi1 --user=username SSL genkey hostname.example.com 2048


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 valid domain name.hostname.example.com
keysizeinteger

Required

The key's size.

This parameter defaults to 2048.

An integer value between 2048 and 4096 that represents a key size, in bits.2048

Returns

This function does not return output. The system writes the key file to the ~/ssl/private/ directory.