Для AI-агентов: markdown этой страницы — /docs-content/management-keys/get.md индекс документации — /llms.txt

Получить API-ключ

GET /v1/keys/:id

Возвращает запись одного API-ключа владельца менеджмент-ключа по её идентификатору, без значения ключа.

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типstring Обяз.да ОписаниеИдентификатор записи ключа. Список: GET /v1/keys

Примеры

Запрос принимает только менеджмент-ключ — см. Ограничения.

curl — менеджмент-ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/keys/6dbad0ce-79a9-43f5-8ca4-3e1af7ef63bc" \
  -H "X-Api-Key: YOUR_MANAGEMENT_KEY"

JavaScript — менеджмент-ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/keys/6dbad0ce-79a9-43f5-8ca4-3e1af7ef63bc', {
  headers: {
    'X-Api-Key': 'YOUR_MANAGEMENT_KEY',
  },
})

const { success, data } = await res.json()
console.log('Ключ:', data.name, '—', data.status)

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata.id Типstring ОписаниеИдентификатор записи ключа
Полеdata.name Типstring ОписаниеНазвание ключа, заданное при создании
Полеdata.prefix Типstring ОписаниеПервые символы значения ключа
Полеdata.suffix Типstring ОписаниеПоследние четыре символа значения ключа
Полеdata.type Типstring ОписаниеТип записи ключа, всегда APP
Полеdata.userId Типstring ОписаниеИдентификатор владельца ключа
Полеdata.portalId Типstring ОписаниеИдентификатор портала
Полеdata.clientId Типstring | null ОписаниеИдентификатор клиента OAuth, если он записан на ключе. Иначе null
Полеdata.scopes Типarray ОписаниеСкоупы ключа
Полеdata.ipWhitelist Типarray ОписаниеРазрешённые IP-адреса. Пустой массив — без ограничения
Полеdata.expiresAt Типstring | null ОписаниеДата окончания срока действия (ISO 8601), null — бессрочный
Полеdata.rateLimit Типnumber | null ОписаниеИндивидуальный лимит запросов к AI-эндпоинтам, null — общий лимит платформы
Полеdata.status Типstring ОписаниеACTIVE, REVOKED, EXPIRED или BLOCKED
Полеdata.lastUsedAt Типstring | null ОписаниеДата последнего запроса этим ключом (ISO 8601)
Полеdata.createdAt Типstring ОписаниеДата создания (ISO 8601)
Полеdata.updatedAt Типstring ОписаниеДата последнего изменения (ISO 8601)
Полеdata.accessMode Типstring ОписаниеREADWRITE или READONLY
Полеdata.totalDefault Типboolean | null ОписаниеПриходит ли meta.total в списках, запрошенных этим ключом. null — действует настройка платформы
Полеdata.issuedVia Типstring | null ОписаниеКанал, которым выписан вебхук ключа: per-portal и cloud-shared — модуль-коннектор на портале, dev_key — ключ разработчика владельца, legacy — регистрация через Битрикс24 Network, none — вебхук не заводился, у ключа только права vibe:*. null, если канал не записан
Полеdata.b24Ready Типboolean | null ОписаниеЕсть ли у ключа рабочие учётные данные для запросов к Битрикс24. null у ключа авторизации приложения и у ключа только со скоупами vibe:*

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

JSON 
{
  "success": true,
  "data": {
    "id": "6dbad0ce-79a9-43f5-8ca4-3e1af7ef63bc",
    "name": "Интеграция с CRM",
    "prefix": "vibe_api_XXXXXXXXX",
    "suffix": "XXXX",
    "type": "APP",
    "userId": "fafa9780-eed7-4d29-b040-2448d924f452",
    "portalId": "0d9f7744-f853-47c7-b06e-6f61f9dd1b7f",
    "clientId": null,
    "scopes": ["crm", "task", "im", "vibe:ai", "vibe:search", "vibe:storage"],
    "ipWhitelist": [],
    "expiresAt": null,
    "rateLimit": null,
    "status": "ACTIVE",
    "lastUsedAt": "2026-10-23T10:01:53.371Z",
    "createdAt": "2026-10-14T07:07:00.732Z",
    "updatedAt": "2026-10-23T10:01:53.371Z",
    "accessMode": "READWRITE",
    "totalDefault": null,
    "issuedVia": "cloud-shared",
    "b24Ready": true
  }
}

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

404 — ключ не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "KEY_NOT_FOUND",
    "message": "API key not found"
  }
}

Ошибки

HTTP Код Описание
HTTP404 КодKEY_NOT_FOUND ОписаниеКлюча с таким id нет, он принадлежит другому пользователю или это менеджмент-ключ
HTTP403 КодMANAGEMENT_SCOPE_REQUIRED ОписаниеУ менеджмент-ключа нет скоупа vibe:mgmt:keys
HTTP401 КодWRONG_KEY_TYPE ОписаниеЗапрос отправлен ключом портала — личным vibe_api_ или ключом авторизации vibe_app_. Эндпоинт принимает только менеджмент-ключ
HTTP401 КодKEY_INACTIVE ОписаниеМенеджмент-ключ отозван или заблокирован
HTTP401 КодKEY_EXPIRED ОписаниеСрок действия менеджмент-ключа закончился
HTTP401 КодINVALID_API_KEY ОписаниеКлюч с переданным значением не найден
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key

Отказы OWNER_DELETED, OWNER_BLOCKED и ACCOUNT_PENDING_ERASURE зависят от аккаунта владельца ключа — см. Состояние аккаунта владельца.

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

Известные особенности

Проверяется владение, а не членство в портале. Запись своего ключа читается, даже когда доступ владельца к порталу ключа отключён и GET /v1/keys с этим portalId отвечает 403 PORTAL_ACCESS_BLOCKED.

Неактивный ключ читается так же, как активный. Запись отозванного, истёкшего или заблокированного ключа возвращается с текущим значением status.

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