- Created by Documentation, last modified on Apr 09, 2018
disable_authentication_provider
disable_failing_authentication_providers
enable_authentication_provider
get_available_authentication_providers
get_provider_client_configurations
get_provider_configuration_fields
get_provider_display_configurations
get_users_authn_linked_accounts
set_provider_client_configurations
set_provider_display_configurations
twofactorauth_generate_tfa_config
twofactorauth_get_user_configs
cpgreylist_is_server_netblock_trusted
cpgreylist_list_entries_for_common_mail_provider
cpgreylist_load_common_mail_providers_config
cpgreylist_save_common_mail_providers_config
cpgreylist_trust_entries_for_common_mail_provider
cpgreylist_untrust_entries_for_common_mail_provider
create_cpgreylist_trusted_host
delete_cpgreylist_trusted_host
Description
This function function deletes an SSH key from the server.
Warning:
Only the root
account can use this function, and it only affects the root
keys. To perform this function on a cPanel user account, call the cPanel API 2 SSH::authkey
function through the WHM API.
Examples
https://hostname.example.com:2087/cpsess##########/json-api/deletesshkey?api.version=1&file=%2Froot%2F.ssh%2Ftest&leave_authorized=0
https://hostname.example.com:2087/cpsess##########/xml-api/deletesshkey?api.version=1&file=%2Froot%2F.ssh%2Ftest&leave_authorized=0
whmapi1 deletesshkey file=%2Froot%2F.ssh%2Ftest leave_authorized=0
Notes:
- You must URI-encode values.
- For more information and additional output options, read our Guide to WHM API 1 documentation or run the
whmapi1 --help
command. If you run CloudLinux™, you must use the full path of the
whmapi1
command:/usr/local/cpanel/bin/whmapi1
{ "data": { "file": "/root/.ssh/test" }, "metadata": { "version": 1, "reason": "OK", "result": 1, "command": "deletesshkey" } }
<result> <data> <file>/root/.ssh/test</file> </data> <metadata> <result>1</result> <command>deletesshkey</command> <reason>OK</reason> <version>1</version> </metadata> </result>
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
user | string | The SSH key's username. | A valid username. | username |
file | string | Required The SSH key file's name. | An absolute file path. | /root/.ssh/test |
leave_authorized | Boolean | Whether to authorize the SSH key to access the server. This parameter defaults to |
|
|
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
file | string | The SSH key file's name. | An absolute path and filename. | /root/.ssh/test |
Function information
API Version:
Available in:
WHM 11+
Methods:
GET, POST
Required Parameters:
file
Return Formats:
About WHM API 1
WHM API 1 performs functions and accesses data in WHM.
Notes:
- Some functions and parameters may require that you authenticate as the
root
user. - You must use the appropriate WHM ports (
2086
or2087
) to call WHM API functions.
Find a function
Related functions
-
Page:
-
Page:
-
Page:
-
Page:WHM API 1 Functions - listcrts — This function lists the server's domains with installed SSL certificates.
-
Page:WHM API 1 Functions - deletesshkey — This function function deletes an SSH key from the server.