Rename File disk.file.rename

Scope: disk

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

The method disk.file.rename renames a file.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

File identifier.

The identifier can be obtained using the method disk.storage.getchildren if the file is located at the root of the storage, and using the method disk.folder.getchildren if the file is located in a folder

newName*
string

New file name.

The file name must be provided along with the extension corresponding to its format. If you use a name without an extension or with an extension that does not match the original, the file will be corrupted

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":8964,"newName":"New File Name.png"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/disk.file.rename

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":8964,"newName":"New File Name.png","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/disk.file.rename

try
        {
            const response = await $b24.callMethod(
                'disk.file.rename',
                {
                    id: 8964,
                    newName: 'New File Name.png'
                }
            );
            
            const result = response.getData().result;
            console.log('Renamed file with ID:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'disk.file.rename',
                    [
                        'id' => 8964,
                        'newName' => 'New File Name.png'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error renaming file: ' . $e->getMessage();
        }

BX24.callMethod(
            "disk.file.rename",
            {
                id: 8964,
                newName: 'New File Name.png'
            },
            function (result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'disk.file.rename',
            [
                'id' => 8964,
                'newName' => 'New File Name.png'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": {
                "ID": "8964",
                "NAME": "New File Name.png",
                "CODE": null,
                "STORAGE_ID": "1357",
                "TYPE": "file",
                "PARENT_ID": "9023",
                "DELETED_TYPE": "0",
                "GLOBAL_CONTENT_VERSION": "1",
                "FILE_ID": "32718",
                "SIZE": "52486",
                "CREATE_TIME": "2026-01-14T17:05:05+01:00",
                "UPDATE_TIME": "2026-02-17T11:59:55+01:00",
                "DELETE_TIME": null,
                "CREATED_BY": "1269",
                "UPDATED_BY": "1269",
                "DELETED_BY": "0",
                "DOWNLOAD_URL": "https://test.bitrix24.com/rest/download.json?auth=343794690000071b006e2cf2000004f500000746484b1f82771b3434ff80eb15edc8f8&token=disk%7CaWQ9ODk2NCZfPXU2V3NhdUVHeXBsY2thekFuTjB3ekNWMFd6d3dwVEZa%7CImRvd25sb2FkfGRpc2t8YVdROU9EazJOQ1pmUFhVMlYzTmhkVVZIZVhCc1kydGhla0Z1VGpCM2VrTldNRnQ2ZDNkd1ZFWmF8MzQzNzk0NjkwMDAwMDcxYjAwNmUyY2YyMDAwMDA0ZjUwMDAwMDc0NjQ4NGIxZjgyNzcxYjM0MzRmZjgwZWIxNWVkYzhmOCI%3D.6Rmg3D5ED7iWrkUSMB7E1%2FTrnlxTtQ3bf8H6drXRVM4%3D",
                "DETAIL_URL": "https://test.bitrix24.com/company/personal/user/1269/disk/file/New File Name.png"
            },
            "time": {
                "start": 1771318795,
                "finish": 1771318795.11888,
                "duration": 0.11888003349304199,
                "processing": 0,
                "date_start": "2026-02-17T11:59:55+01:00",
                "date_finish": "2026-02-17T11:59:55+01:00",
                "operating_reset_at": 1771319395,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `array`	Array with file fields
ID `integer`	File identifier
NAME `string`	File name
CODE `string`	Symbolic code of the file
STORAGE_ID `integer`	Identifier of the storage where the file is located
TYPE `enum`	Object type
PARENT_ID `integer`	Identifier of the parent folder
DELETED_TYPE `enum`	Deletion status of the object. Possible values: `0` — not deleted `3` — in the 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 may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description	Value
`ERROR_ARGUMENT`	Invalid value of parameter	Required parameter `id` or `newName` is missing
`ERROR_NOT_FOUND`	Could not find entity with id `X`	File with the specified `id` not found
`DISK_OBJ_22000`	A file with that name already exists	A file with that name already exists
`0`	Empty name	An empty file name was provided
`ACCESS_DENIED`	Access denied	Insufficient permissions to rename the file

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Move File to Folder

Restore File from Version

Rename File disk.file.rename

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning