#Удалить ключ

DELETE /v1/search/credentials/:id

Удаляет BYOK-ключ текущего пользователя. Восстановить ключ через API нельзя — добавьте новый через `POST /v1/search/credentials` при необходимости.

#Параметры

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

#Примеры

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

Terminal 
curl -X DELETE \
  -H "X-Api-Key: YOUR_API_KEY" \
  https://vibecode.bitrix24.tech/v1/search/credentials/cmol3pnk5001fo70zefbwb6dl

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

Terminal 
curl -X DELETE \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  https://vibecode.bitrix24.tech/v1/search/credentials/cmol3pnk5001fo70zefbwb6dl

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

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/search/credentials/cmol3pnk5001fo70zefbwb6dl',
  {
    method: 'DELETE',
    headers: { 'X-Api-Key': 'YOUR_API_KEY' },
  },
)

if (res.status === 204) {
  console.log('Ключ удалён')
}

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

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

if (res.status === 204) {
  console.log('Ключ удалён')
}

#Ответ

При успешном удалении возвращается HTTP-статус 204 No Content с пустым телом. Признак успеха — код ответа, не содержимое.

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

HTTP/1.1 204 No Content

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

404 — ключ не найден или принадлежит другому пользователю:

JSON 
{
  "error": {
    "code": "CREDENTIAL_NOT_FOUND",
    "message": "cmol3pnk5001fo70zefbwb6dl"
  }
}

#Ошибки

HTTP Код Описание
401 MISSING_API_KEY Отсутствует заголовок X-Api-Key
401 INVALID_API_KEY Неверный API-ключ
401 UNAUTHORIZED Запрос идёт через ключ vibe_app_… без Authorization: Bearer <session_token>
403 SCOPE_DENIED Ключу не хватает скоупа vibe:search
404 CREDENTIAL_NOT_FOUND Ключ с таким id отсутствует у текущего пользователя
429 RATE_LIMITED Превышен общий лимит запросов
500 INTERNAL_ERROR Внутренняя ошибка сервера

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

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

Чужой ключ не доступен. При попытке удалить ключ другого пользователя сервер возвращает 404 CREDENTIAL_NOT_FOUND — без указания, существует ли запись в системе.

Удаление дефолтного ключа. Когда удалён дефолтный ключ, последующие `POST /v1/search` без явного provider снова идут по каскаду USER → PORTAL → PLATFORM. Если других USER-ключей не осталось, запросы пойдут через bitrix-search.

Повтор удаления. Повторный DELETE на тот же id возвращает 404 CREDENTIAL_NOT_FOUND. Используйте 204 как сигнал «удалено сейчас», 404 — как «ключа уже нет».

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