Child pages
  • cPanel API 2 Functions - SSH::authkey
Skip to end of metadata
Go to start of metadata

 

Description

This function authorizes an SSH key.


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=SSH&cpanel_jsonapi_func=authkey&key=user&action=authorize


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.
 
// Authorize the SSH key for "user"
$list_key = $cpanel->api2(
    'SSH', 'authkey', 
    array(
        'key' => 'user',
        'action' => 'authorize',
 ) 
);


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.
 
# Authorize the SSH key for "user"
my $authorize_key = $cpliveapi->api2(
    'SSH', 'authkey',
    {
        'key' => 'user',
        'action' => 'authorize',
    }
);


Note:

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

 

 cPanel Tag System (deprecated)


Warnings:

  • In cPanel & WHM version 11.30 and later, 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 SSH authkey key=user action=authorize


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • 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": "authkey",
    "data": [
      {
        "status": "authorized",
        "name": "user.pub"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "SSH"
  }
}


Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
keystring

Required

The SSH key's filename.

A valid string.

Note:

The following names are reserved:

  • config
  • known_hosts
  • authorized_keys
  • environment
  • rc
  • identity
user
actionstring

Required

Whether to authorize or deauthorize the key.

  • authorize — Authorize the key.
  • deauthorize — Deauthorize the key.
authorize

Returns

ReturnTypeDescriptionPossible valuesExample
namestring

The SSH key's filename.

A string that contains the fingerprint and file location.user.pub
statusstringThe SSH key's status.
  • authorized
  • deauthorized
authorized
reasonstring

A reason for failure.

Note:

This function only returns a reason value if it failed.

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