cPanel API 2 Functions - Gpg::number_of_private_keys

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.

 

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

 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'
     
);

 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',
 
  );

 cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that youonly use the LiveAPI system to call the cPanel APIs.

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

 

 Command Line

cpapi2 --user=username Gpg number_of_private_keys

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 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 (Home >> Advanced >> API Shell) to directly test cPanel API calls.

 

Parameters

This function does not accept parameters.

Returns

 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

 

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....