JavaScript

Delete a Remote File on an SFTP Server

Demonstrates the Chilkat SFtp.RemoveFile method, which deletes a remote file. The only argument is the file path.

Background: Deletion is immediate and permanent — SFTP has no trash or undo — so a job that removes files should be certain of the path first. Whether deletion is even allowed depends on the account's permissions on the file and its containing directory, since on Unix-like systems the right to remove a file comes from write permission on the directory, not the file itself.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

JavaScript

var success = false;

//  Demonstrates the SFtp.RemoveFile method, which deletes a remote file.  The only argument is
//  the file path.

var sftp = new CkSFtp();

//  Connect, authenticate, and initialize the SFTP subsystem.
var port = 22;
success = sftp.Connect("sftp.example.com",port);
if (success == false) {
    console.log(sftp.LastErrorText);
    return;
}

//  Normally you would not hard-code the password in source.  You should instead obtain it
//  from an interactive prompt, environment variable, or a secrets vault.
var password = "mySshPassword";

success = sftp.AuthenticatePw("mySshLogin",password);
if (success == false) {
    console.log(sftp.LastErrorText);
    return;
}

success = sftp.InitializeSftp();
if (success == false) {
    console.log(sftp.LastErrorText);
    return;
}

//  Delete a remote file.
success = sftp.RemoveFile("subdir/obsolete.txt");
if (success == false) {
    console.log(sftp.LastErrorText);
    return;
}

console.log("File removed.");

sftp.Disconnect();