Rename Application Storage disk.storage.rename
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
diskWho can execute the method: administrator
The method disk.storage.rename renames the application storage.
The method works only in the context of the application
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the application storage. The identifier can be obtained using the method disk.storage.getforapp |
|
newName* |
New name for the storage |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1366,"newName":"Bitrix REST API","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/disk.storage.rename
try
{
const response = await $b24.callMethod(
'disk.storage.rename',
{
id: 1366,
newName: 'Bitrix REST API'
}
);
const result = response.getData().result;
console.log('Renamed storage:', result);
processResult(result);
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'disk.storage.rename',
[
'id' => 1366,
'newName' => 'Bitrix REST API'
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error renaming storage: ' . $e->getMessage();
}
BX24.callMethod(
"disk.storage.rename",
{
id: 1366,
newName: 'Bitrix REST API'
},
function (result)
{
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'disk.storage.rename',
[
'id' => 1366,
'newName' => 'Bitrix REST API'
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"ID": "1366",
"NAME": "Bitrix REST API",
"CODE": null,
"MODULE_ID": "disk",
"ENTITY_TYPE": "restapp",
"ENTITY_ID": "3",
"ROOT_OBJECT_ID": "8910"
},
"time": {
"start": 1770048169,
"finish": 1770048169.935598,
"duration": 0.9355978965759277,
"processing": 0,
"date_start": "2026-02-02T14:02:49+01:00",
"date_finish": "2026-02-02T14:02:49+01:00",
"operating_reset_at": 1770048769,
"operating": 0.11735081672668457
}
}
Returned Data
|
Name |
Description |
|
result |
Array with the description of the storage fields |
|
ID |
Identifier of the storage |
|
NAME |
Name of the storage |
|
CODE |
Symbolic code of the storage |
|
MODULE_ID |
Identifier of the module to which the storage belongs |
|
ENTITY_TYPE |
Type of the object associated with the storage |
|
ENTITY_ID |
Identifier of the object associated with the storage |
|
ROOT_OBJECT_ID |
Identifier of the root folder of the storage |
|
time |
Information about the execution time of the request |
Error Handling
HTTP Status: 400
{
"error":"ERROR_NOT_FOUND",
"error_description":"Could not find entity with id `X`"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
Could not find entity with id |
Storage with the specified |
|
— |
Access denied (invalid type of storage) |
Storage not associated with the application |
|
|
Access denied |
Insufficient permissions to rename the storage |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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
- Create a Folder in the Root of the Storage disk.storage.addfolder
- Get a list of files and folders in the root of the storage disk.storage.getchildren
- Get Description of Storage Fields disk.storage.getfields
- Get Application Storage Description disk.storage.getforapp
- Get a List of Available Storages disk.storage.getlist
- Get Storage Types disk.storage.gettypes
- Get Storage Description disk.storage.get
- Upload a New File to the Root of the Storage disk.storage.uploadfile