Description

This function updates an entry in the /home/user/.ssh/known_hosts file.


Examples  




https://hostname.example.com:2083/cpsess##########/execute/KnownHosts/update?host_name=host.example.com



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



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# update the host
my $update = $cpliveapi->uapi(
    'KnownHosts', 'update',    {
        'host_name'    => 'host.example.com',
    }
);



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



uapi --user=username KnownHosts update host_name=host.example.com



{  
   "errors":null,
   "data":{

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

   },
   "messages":null
}



Parameters

ParameterTypeDescriptionPossible valuesExample
host_namestring

Required

The host to update.

A valid hostname.

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.