Child pages
  • UAPI Functions - KnownHosts::delete
Skip to end of metadata
Go to start of metadata

Description

This function removes a host from the /home/user/.ssh/known_hosts file.

Examples  


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/KnownHosts/delete?host_name=host.example.com


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// delete the host
$delete = $cpanel->uapi(
    'KnownHosts', 'delete',
     array(
        'host_name'    => 'host.example.com';
     )
);


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 host
my $delete = $cpliveapi->uapi(
    'KnownHosts', 'delete',    {
        'host_name'    => 'host.example.com',
    }
);


Note:

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

 cPanel Template Toolkit
<!-- delete the host. -->
[% data = execute( 
   'KnownHosts', 'delete', {
        'host_name'    => 'host.example.com',
   } 
); %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username KnownHosts delete host_name=host.example.com


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{  
   "errors":null,
   "data":{

   },
   "status":1,
   "metadata":{
  
   },
   "messages":null
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
host_namestring

Required

The host to delete.

A valid hostname.

host.example.com

portinteger

The SSH port to use, if the system uses a non-standard SSH port.

If you do not supply a value, the function uses the standard SSH port (22).

A valid port number.1234

 

Returns

This function only returns metadata.