Skip to main content
DELETE
/
boxes
/
{boxId}
/
fs
JavaScript
import GboxSDK from "gbox-sdk";

const gboxSDK = new GboxSDK({
  apiKey: process.env["GBOX_API_KEY"] // This is the default and can be omitted
});

async function main() {
  const box = await gboxSDK.create({ type: "linux" });
  // prepare: write a file
  await box.fs.write({
    path: "/tmp/example.txt",
    content: "Hello, world!",
  });

  // Delete a file
  const deleteResult = await box.fs.remove({
    path: "/tmp/example.txt",
  });

  console.log("File deleted successfully:", deleteResult.message);
}

main();
{
  "message": "File/Directory deleted successfully"
}

Authorizations

​
Authorization
string
header
required

Enter your API Key in the format: Bearer . Get it from https://gbox.ai

Path Parameters

​
boxId
string
required

Box ID

Example:

"c9bdc193-b54b-4ddb-a035-5ac0c598d32d"

Body

application/json

Request parameters for deleting a file/directory

​
path
string
required

Target path in the box. If the path does not start with '/', the file/directory will be deleted relative to the working directory. If the target path does not exist, the delete will fail.

Example:

"/home/user/documents/output.txt"

​
workingDir
string

Working directory. If not provided, the file will be read from the box.config.workingDir directory.

Example:

"/home/user/documents"

Response

Delete file/dir

Response after deleting file/directory

​
message
string
required

Success message

Example:

"File/Directory deleted successfully"