Description

This function retrieves the number of public GPG keys.

Examples 




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_public_keys



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Retrieve number of public keys installed for the user.
$get_number_public_keys = $cpanel->api2(
    'Gpg', 'number_of_public_keys'
	
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Retrieve number of public keys installed for the user.
my $get_number_public_keys = $cpliveapi->api2(
	'Gpg', 'number_of_public_keys',

  );

 




cpapi2 --user=username Gpg number_of_public_keys



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



Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
countinteger

The number of public GPG keys on the account.

Any positive integer.5
reasonstring

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.  
resultBoolean

Whether the function succeeded.

 

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