cPanel API 2 Functions - Gpg::number_of_private_keys

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Description

This function retrieves the number of private GPG keys.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Important:

When you disable the Receive Mail role, the system disables this function.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Gpg&cpanel_jsonapi_func=number_of_private_keys

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.

// Retrieve number of private keys installed for the user
$get_number_keys = $cpanel->api2(
    'Gpg', 'number_of_private_keys'

);

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.

# Retrieve number of private keys installed for the user.
my $get_number_keys = $cpliveapi->api2(
    'Gpg', 'number_of_private_keys',

  );

Note:

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

cPanel Tag System (deprecated)

Warnings:

cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI .
cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

cpapi2 --user=username Gpg number_of_private_keys

Notes:

You must URI-encode values.
username represents your account-level username.
You must include the --user=username option.
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "number_of_private_keys",
    "data": [
      {
        "count": "5"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Gpg"
  }
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return Type Description Possible values Example

Return	Type	Description	Possible values	Example
`count`	integer	The number of private GPG keys on the account.	Any positive integer.	`5`
`reason`	string	A reason for failure. This function only returns a `reason` value if there was an error.	A string that describes the error.	`This is an error message.`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`

count

integer

The number of private GPG keys on the account.

Any positive integer.

5

reason

string

A reason for failure.

This function only returns a reason value if there was an error.

A string that describes the error.

This is an error message.

result

Boolean

Whether the function succeeded.

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

1