cPanel API 2 Functions - SSH::authkey - Knowledgebase

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

 LiveAPI PHP Class

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

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

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use theLiveAPI 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 ourDeprecated 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 SSH authkey key=user action=authorize

Notes:

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

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

Parameters

Parameter	Type	Description	Possible values	Example
key	string	Required The SSH key's filename.	A valid string. Note: The following names are reserved: config known_hosts authorized_keys environment rc identity	user
action	string	Required Whether to authorize or deauthorize the key.	authorize — Authorize the key. deauthorize — Deauthorize the key.	authorize

Parameter

Type

Description

Possible values

Example

key

string

Required

The SSH key's filename.

A valid string.

Note:

The following names are reserved:

config
known_hosts
authorized_keys
environment
rc
identity

user

action

string

Required

Whether to authorize or deauthorize the key.

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

authorize

Returns

Return	Type	Description	Possible values	Example
name	string	The SSH key's filename.	A string that contains the fingerprint and file location.	user.pub
status	string	The SSH key's status.	authorized deauthorized	authorized
reason	string	A reason for failure. Note: This function only returns a reasonvalue if it failed.	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

Knowledgebase

Categories

Categories