cPanel API 1 Functions - Gpg::genkey

UAPI (recommended) — UAPI Functions - GPG::generate_key — This function generates a GnuPG key. The system saves the key in the user's .gnupg directory.

Examples

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$generate_key = $cpanel->api1('Gpg', 'genkey', array('Helena', 'But what if it was the chicken?', 'user@example.com', '1y', '2048', '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 $generate_key = $cpliveapi->api1('Gpg', 'genkey', ['Helena', 'But what if it was the chicken?', 'user@example.com', '1y', '2048', '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="Gpg::genkey($FORM('name','comment','email','expire','keysize','passphrase'))">

Command Line

cpapi1 --user=username Gpg genkey Helena "But what if it was the chicken?" user@example.com 1y 2048 12345luggage

Notes:

Unless otherwise noted, you must URI-encode values.
For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
If you run CloudLinux™, you must use the full path of the whmapi1 command:
```
/usr/local/cpanel/bin/whmapi1
```

Output (boolean)

Parameters

Parameter	Type	Description	Possible values	Example
`name`	string	Required The person for whom to generate the key.	Any string that contains at least five characters.	`Helena`
`comment`	string	A comment about the key.	Any string.	But what if it was the chicken?
`email`	string	Required The email address to encode.	A valid email address.	`user@example.com`
`expire`	string	The desired amount of time between the key's creation (when this function runs) and its expiration.	`#y` — `#` years. `#m` — `#` months. `#w` — `#` weeks. `#d` — `#` days. Note: Replace `#` with one or more digits.	`1y`
`keysize`	integer	The new key's size, in bytes. Note: Large keys require more time to generate.	`1024` `2048` `3072` `4096`	2048
`passphrase`	string	The key's password.	A secure password.	`12345luggage`

Returns

1 — The function succeeded.
0 — The function failed.

Function information

Module:

Gpg

API Version:

cPanel API 1

Available in:

cPanel 11+

Methods:

GET, POST

Required Parameters:

name, email

Return Formats:

boolean

About this module

The Gpg module manages GnuPG keys.

Note:

This module requires access to the gpg feature, and is not available in demo mode.

About cPanel API 1

cPanel API 1 accesses information about cPanel accounts.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you use cPanel API 2 or UAPI instead.

Notes:

These functions may require a feature list. To view the available feature lists on a cPanel server, view WHM's Feature Manager interface.
Unless you call this API via the WHM API, you must use the appropriate cPanel ports ( 2082 or 2083 ). You can also call some functions via cPanel's Webmail ports ( 2095 or 2096 ).

Find a function

Related functions

Page:

cPanel API 1 Modules - Gpg — The Gpg module manages GnuPG keys.
Page:

cPanel API 1 Functions - Gpg::exportkey — This function returns a public GnuPG key.
Page:

cPanel API 1 Functions - Gpg::deletekey — This function deletes a GnuPG key.
Page:

cPanel API 1 Functions - Gpg::importkeys — This function imports a GnuPG key.
Page:

cPanel API 1 Functions - Gpg::exportsecretkey — This function returns a private GnuPG key.

Child pages

cPanel API 1 Functions - Gpg::genkey

Description

Examples

Parameters

Returns

Function information

About this module

About cPanel API 1

Find a function

Search

Related functions