Restore File from Trash disk.file.restore

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: disk

Who can execute the method: a user with "Edit" access permission for the required file

The method disk.file.restore restores a file from the trash.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Identifier of the file located in the trash.

Files in the trash are not accessible through standard methods. To obtain the identifier of the file for restoration, save it immediately after calling the method disk.file.markDeleted

If there is already a file with the same name in the folder, a number will be automatically added to the name upon restoration. For example, instead of 'New Spreadsheet.xlsx', 'New Spreadsheet (1).xlsx' will be created.

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":9037}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/disk.file.restore
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":9037,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/disk.file.restore
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type DiskFileRestoreResult = {
          ID: string
          NAME: string
          CODE: string | null
          STORAGE_ID: string
          TYPE: string
          PARENT_ID: string
          DELETED_TYPE: number
          GLOBAL_CONTENT_VERSION: string
          FILE_ID: string
          SIZE: string
          CREATE_TIME: ISODate | null
          UPDATE_TIME: ISODate | null
          DELETE_TIME: ISODate | null
          CREATED_BY: string
          UPDATED_BY: string
          DELETED_BY: string
          DOWNLOAD_URL: string
          DETAIL_URL: string
        }
        
        try {
          const response = await $b24.actions.v2.call.make<DiskFileRestoreResult>({
            method: 'disk.file.restore',
            params: {
              id: 9037,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info(result.NAME, result.ID, result.DOWNLOAD_URL)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function restoreFile() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'disk.file.restore',
                params: {
                  id: 9037,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info(result.NAME, result.ID, result.DOWNLOAD_URL)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', restoreFile)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.disk.file.restore(
                bitrix_id=9037,
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'disk.file.restore',
                    [
                        'id' => 9037
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error restoring file: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "disk.file.restore",
            {
                id: 9037
            },
            function (result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'disk.file.restore',
            [
                'id' => 9037
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "disk.file.restore", b24.Params{
        	"id": 9037,
        })
        if err != nil {
        	return fmt.Errorf("disk.file.restore: %w", err)
        }
        
        var item struct {
        	ID          b24.ID `json:"ID"`
        	Name        string `json:"NAME"`
        	StorageID   b24.ID `json:"STORAGE_ID"`
        	Type        string `json:"TYPE"`
        	ParentID    b24.ID `json:"PARENT_ID"`
        	DeletedType int    `json:"DELETED_TYPE"`
        }
        if err := json.Unmarshal(res.Result, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Name)
        

Response Handling

HTTP Status: 200

{
            "result": {
                "ID": "9037",
                "NAME": "picture.png",
                "CODE": null,
                "STORAGE_ID": "1357",
                "TYPE": "file",
                "PARENT_ID": "8930",
                "DELETED_TYPE": 0,
                "GLOBAL_CONTENT_VERSION": "1",
                "FILE_ID": "32933",
                "SIZE": "1679",
                "CREATE_TIME": "2026-02-09T17:35:49+01:00",
                "UPDATE_TIME": "2026-02-16T14:57:24+01:00",
                "DELETE_TIME": "2026-02-16T14:43:38+01:00",
                "CREATED_BY": "1269",
                "UPDATED_BY": "1269",
                "DELETED_BY": "1269",
                "DOWNLOAD_URL": "https://test.bitrix24.com/rest/download.json?auth=845a93690000071b006e2cf2000004f50000076345539a39c27ec694f85bece0eed696&token=disk%7CaWQ9OTAzNyZfPUljQlU8VVAyMldDUG95bW51NlBmUUVVazlPeUd5WUlR%7CImRvd25sb2FkfGRpc2t8YVdROU9UQXpOeVpmUFVsalFsVTFWVkF5TWxkRFVHOTViVzUxTmxCbVVVVlZhemxQZVVkNVdVbFJ8ODQ1YTkzNjkwMDAwMDcxYjAwNmUyY2YyMDAwMDA0ZjUwMDAwMDc2MzQ1NTM5YTM5YzI3ZWM2OTRmODViZWNlMGVlZDY5NiI%3D.axFboRC%2FEf5h1jXPcqNbho7BDEsZqxfVUEf2yL6aqe0%3D",
                "DETAIL_URL": "https://test.bitrix24.com/company/personal/user/1269/disk/file/Folder/Folder in folder/picture (1).png"
            },
            "time": {
                "start": 1771261044,
                "finish": 1771261044.790871,
                "duration": 0.7908709049224854,
                "processing": 0,
                "date_start": "2026-02-16T14:57:24+01:00",
                "date_finish": "2026-02-16T14:57:24+01:00",
                "operating_reset_at": 1771261644,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
array

Array containing file fields

ID
integer

Identifier of the file

NAME
string

Name of the file

CODE
string

Symbolic code of the file

STORAGE_ID
integer

Identifier of the storage where the file is located

TYPE
enum

Type of the object

PARENT_ID
integer

Identifier of the parent folder

DELETED_TYPE
enum

Deletion status of the object. Possible values:

  • 0 — not deleted
  • 3 — in trash
  • 4 — deleted along with the parent folder

GLOBAL_CONTENT_VERSION
integer

Incremental version counter of the file

FILE_ID
integer

Internal value of the file identifier

SIZE
integer

Size of the file in bytes

CREATE_TIME
datetime

Date and time of file creation

UPDATE_TIME
datetime

Date and time of the last update of the file

DELETE_TIME
datetime

Date and time the file was moved to the trash

CREATED_BY
integer

Identifier of the user who created the file

UPDATED_BY
integer

Identifier of the user who made the last change

DELETED_BY
integer

Identifier of the user who deleted the file

DOWNLOAD_URL
string

Link to download the file

DETAIL_URL
string

Link to open the file in the interface

time
time

Information about the execution time of the request

Error Handling

HTTP Status: 400

{
            "error":"ERROR_ARGUMENT",
            "error_description":"Invalid value of parameter {Parameter #0}"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

Value

ERROR_ARGUMENT

Invalid value of parameter

Required parameter id is missing

ERROR_NOT_FOUND

Could not find entity with id X

File with the specified id not found

ACCESS_DENIED

Access denied

Insufficient permissions to restore the file

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning