Skip to main content

Manage the Trash section

This example demonstrates how to retrieve, restore, and empty the contents of the Trash section in ONLYOFFICE DocSpace using the API.

Before you start​

  1. Replace https://yourportal.onlyoffice.com and YOUR_API_KEY with your actual DocSpace portal URL and API key. Ensure you have the necessary data and permissions to perform migration operations.
  2. Before you can make requests to the API, you need to authenticate. Check out the Personal access tokens page to learn how to obtain and use access tokens.
Full example
// Set API base URL
const API_HOST = 'https://yourportal.onlyoffice.com';
const API_KEY = 'your_api_key';

// Headers with API key for authentication
const HEADERS = {
  Authorization: `Bearer ${API_KEY}`,
  'Content-Type': 'application/json',
};

// Step 1: Get contents of the Trash section
async function getTrashSection() {
  const url = `${API_HOST}/api/2.0/files/@trash`;
  const res = await fetch(url, { method: 'GET', headers: HEADERS });
  if (!res.ok) {
    const t = await res.text();
    console.log(`Failed to get Trash: ${res.status} - ${t}`);
    return null;
  }
  return res.json();
}

// Step 2: Empty the Trash section
async function emptyTrash() {
  const url = `${API_HOST}/api/2.0/files/fileops/emptytrash`;
  const res = await fetch(url, { method: 'PUT', headers: HEADERS });
  if (!res.ok) {
    const t = await res.text();
    console.log(`Failed to empty Trash: ${res.status} - ${t}`);
    return false;
  }

  console.log('Trash emptied successfully.');
  return true;
}

// Step 3: Restore a file from Trash to a specific folder
async function restoreFile(fileId, destFolderId) {
  const url = `${API_HOST}/api/2.0/files/fileops/move`;
  const body = JSON.stringify({
    fileIds: [fileId],
    destFolderId: destFolderId,
    deleteAfter: true,
    content: true,
  });

  const res = await fetch(url, { method: 'PUT', headers: HEADERS, body });
  if (!res.ok) {
    const t = await res.text();
    console.log(`Failed to restore file ${fileId}: ${res.status} - ${t}`);
    return false;
  }

  console.log(`File ${fileId} restored to folder ${destFolderId}.`);
  return true;
}

// Run
(async () => {
  await getTrashSection();

  const file_id = '123456';   // Replace with a real file ID from Trash
  const folder_id = '654321'; // Replace with destination folder ID
  await restoreFile(file_id, folder_id);

  await emptyTrash();
})();

Step 1: Retrieve Trash contents​

A GET request is sent to /api/2.0/files/@trash to get files and folders marked for deletion.

This operation is useful for checking which items are pending permanent removal.

async function getTrashSection() {
  const url = `${API_HOST}/api/2.0/files/@trash`;
  const res = await fetch(url, { method: 'GET', headers: HEADERS });
  if (!res.ok) {
    const t = await res.text();
    console.log(`Failed to get Trash: ${res.status} - ${t}`);
    return null;
  }
  return res.json();
}

Step 2: Empty the Trash​

A PUT request is sent to /api/2.0/files/fileops/emptytrash.

This operation permanently deletes all files and folders from the Trash.

async function emptyTrash() {
  const url = `${API_HOST}/api/2.0/files/fileops/emptytrash`;
  const res = await fetch(url, { method: 'PUT', headers: HEADERS });
  if (!res.ok) {
    const t = await res.text();
    console.log(`Failed to empty Trash: ${res.status} - ${t}`);
    return false;
  }

  console.log('Trash emptied successfully.');
  return true;
}

Step 3: Restore files from Trash​

A PUT request is sent to /api/2.0/files/fileops/move with:

  • fileIds: A list of file IDs to restore.
  • destFolderId: Target folder to move the file into.
  • deleteAfter: True — remove the item from Trash.
  • content: True — preserve file contents.

This operation is useful for selectively restoring documents from Trash back to a specific folder.

async function restoreFile(fileId, destFolderId) {
  const url = `${API_HOST}/api/2.0/files/fileops/move`;
  const body = JSON.stringify({
    fileIds: [fileId],
    destFolderId: destFolderId,
    deleteAfter: true,
    content: true,
  });

  const res = await fetch(url, { method: 'PUT', headers: HEADERS, body });
  if (!res.ok) {
    const t = await res.text();
    console.log(`Failed to restore file ${fileId}: ${res.status} - ${t}`);
    return false;
  }

  console.log(`File ${fileId} restored to folder ${destFolderId}.`);
  return true;
}