Получить хранилище

GET /v1/storages/:id

Возвращает одно хранилище Битрикс24.Диска по идентификатору.

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор хранилища

Примеры

curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/storages/1" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/storages/1" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/storages/1', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Хранилище:', data.name, '—', data.entityType)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/storages/1', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.id number Идентификатор хранилища
data.name string Название хранилища
data.code string | null Символьный код. На проверенных порталах null
data.module string Модуль-владелец хранилища, для Диска — disk
data.entityType string Тип владельца: user, group, common
data.entityId string Идентификатор владельца. Строка, у общего диска нечисловая, например shared_files_s1
data.rootFolderId number Идентификатор корневой папки хранилища

Пример ответа

JSON 
{
  "success": true,
  "data": {
    "id": 1,
    "name": "Летта",
    "code": null,
    "module": "disk",
    "entityType": "user",
    "entityId": "1",
    "rootFolderId": 1
  }
}

Пример ответа при ошибке

404 — хранилище не найдено:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Could not find entity with id '999999'."
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Хранилище с указанным id не существует или недоступно пользователю
403 SCOPE_DENIED API-ключ не имеет скоупа disk
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

Полный список общих ошибок API — Ошибки.

Смотрите также