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

Настройки сайта

GET /v1/sites/:id/settings

Ключи хуков сохраняются как есть. Значения HTML/JS являются данными JSON: не исполняйте их. Пустые значения Б24 не возвращает. Если у существующего сайта нет заполненных настроек, ответ содержит data: {}. ADDITIONAL_FIELDS не объявлено в сущности sites; PATCH /v1/sites/:id не предоставляет отдельного контракта записи этих настроек.

Параметры

Parameter Type Required Description
id integer yes Positive safe integer site ID
scope string no KNOWLEDGE / GROUP / MAINPAGE; omit for ordinary sites

Нужен скоуп ключа landing. Без scope сайт базы знаний или группы может быть невидим.

curl

Terminal
curl -X GET "https://vibecode.bitrix24.tech/v1/sites/42/settings" -H "X-Api-Key: YOUR_API_KEY"

JavaScript

javascript
const response = await fetch("https://vibecode.bitrix24.tech/v1/sites/42/settings", {
  method: "GET",
  headers: { "X-Api-Key": "YOUR_API_KEY" },
});
const data = await response.json();

Ответ

JSON
{
  "success": true,
  "data": {
    "HEADBLOCK_CODE": "<meta name=\"example\" content=\"data\">"
  }
}

Ошибки

400 INVALID_PARAMS / INVALID_SCOPE; 401 TOKEN_MISSING; 403 SCOPE_DENIED / BITRIX_ACCESS_DENIED; 404 ENTITY_NOT_FOUND; 409 LANDING_MODULE_NOT_ENABLED; 422 BITRIX_ERROR; 429 rate limits; 502 / 503 upstream or transport refusal. Записывающие операции с READONLY-ключом дают 403 WRITE_BLOCKED_READONLY_KEY.

Bitrix24: landing.site.getadditionalfields.

Сайты