cPanel API 2 Functions - SSH::delkey

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function deletes 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=delkey&name=user

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.

// Delete the "user' SSH key
$delete_key = $cpanel->api2(
    'SSH', 'delkey',
    array(
        'name' => 'user',
 )
);

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.

# Delete the "user' SSH key
my $delete_key = $cpliveapi->api2(
    'SSH', 'genkey',
    {
        'name' => 'user',
    }
);

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 SSH genkey name=user

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": "delkey",
    "data": [
      {
        "leave_authorized": null,
        "name": "user",
        "keyfile": "/home/example/.ssh/user"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "SSH"
  }
}

Note:

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

Parameters

Parameter Type Description Possible values Example

Parameter	Type	Description	Possible values	Example
`name`	string	Required The SSH key's filename.	A valid string.	`user`
`pub`	string	Whether to retrieve the public or private key. This value defaults to `0`.	`1` — Retrieve the public key. `0` — Retrieve the private key.	`0`

name

string

Required

The SSH key's filename.

A valid string.

user

pub

string

Whether to retrieve the public or private key.

This value defaults to 0.

1 — Retrieve the public key.
0 — Retrieve the private key.

0

Returns

Return	Type	Description	Possible values	Example
`leave_authorized`	string	The SSH key that will remain authorized.	`public` — Public. `private` — Private. `null` — Neither.	`null`
`name`	string	The SSH key's filename.	A string that contains the fingerprint and file location.	`user`
`keyfile`	string	The SSH key file's former location.	A valid filepath.	`/home/example/.ssh/user`
`reason`	string	A reason for failure. This function only returns a `reason` value 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`