Экспортировать сайт landing.site.fullExport

Scope: landing

Кто может выполнять метод: пользователь с правом «экспорт» сайтов

Метод landing.site.fullExport экспортирует сайт и его страницы в массив для последующего импорта, например через landing.demos.register.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

id*
integer

Идентификатор сайта.

Идентификатор сайта можно получить с помощью метода landing.site.getList или из результата метода landing.site.add

params
object

Дополнительные параметры экспорта (подробное описание)

Страницы внутри экспорта выбираются в порядке ID ASC и возвращаются одним ответом.

Параметр params

Обязательные параметры отмечены *

Название `тип`	Описание
edit_mode `string`	Режим экспорта хуков. При значении `Y` включается режим редактирования. По умолчанию используется обычный режим
scope `string`	Внутренний скоуп лендингов. Он не связан с REST-скоупом `landing` или `landing_cloud` в названии метода. Для `GROUP`, `KNOWLEDGE` и `MAINPAGE` значение `scope` должно соответствовать типу экспортируемого сайта
hooks_disable `string[]`	Коды дополнительных полей, которые нужно исключить из `ADDITIONAL_FIELDS` на уровне сайта и страниц. Если параметр не передан, используется пустой массив. Независимо от входных данных метод всегда дополнительно исключает `B24BUTTON_CODE` и `FAVICON_PICTURE`
code `string`	Код экспортируемого сайта. Если не передан, используется текущий код сайта без крайних `/`. Допустимы только латинские буквы и цифры (`[a-z0-9]`, без разделителей)
name `string`	Название сайта в экспорте. Если не передано, используется текущее название сайта
description `string`	Описание сайта в экспорте. Если не передано, используется текущее описание сайта
preview `string`	URL основной превью-картинки. По умолчанию пустая строка
preview2x `string`	URL увеличенной превью-картинки. По умолчанию пустая строка
preview3x `string`	URL retina-превью. По умолчанию пустая строка
preview_url `string`	URL предпросмотра шаблона. По умолчанию пустая строка

Параметры name, description, preview, preview2x, preview3x и preview_url применяются к данным страницы только если сайт содержит одну страницу. Если страниц несколько, эти параметры задают верхний уровень экспорта сайта, а данные страниц берутся из текущих значений каждой страницы.

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 326,
            "params": {
              "edit_mode": "Y",
              "code": "myfirstsite2026",
              "name": "Сайт автомастерской",
              "description": "Сайт для автосервиса",
              "preview_url": "https://example.com/previews/myfirstsite2026"
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.site.fullExport.json"

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 326,
            "params": {
              "edit_mode": "Y",
              "code": "myfirstsite2026",
              "name": "Сайт автомастерской",
              "description": "Сайт для автосервиса",
              "preview_url": "https://example.com/previews/myfirstsite2026"
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.site.fullExport.json"

try
        {
        	const response = await $b24.callMethod(
        		'landing.site.fullExport',
        		{
        			id: 326,
        			params: {
        				edit_mode: 'Y',
        				code: 'myfirstsite2026',
        				name: 'Сайт автомастерской',
        				description: 'Сайт для автосервиса',
        				preview_url: 'https://example.com/previews/myfirstsite2026'
        			}
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.site.fullExport',
                    [
                        'id' => 326,
                        'params' => [
                            'edit_mode' => 'Y',
                            'code' => 'myfirstsite2026',
                            'name' => 'Сайт автомастерской',
                            'description' => 'Сайт для автосервиса',
                            'preview_url' => 'https://example.com/previews/myfirstsite2026',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error exporting site: ' . $e->getMessage();
        }

BX24.callMethod(
            'landing.site.fullExport',
            {
                id: 326,
                params: {
                    edit_mode: 'Y',
                    code: 'myfirstsite2026',
                    name: 'Сайт автомастерской',
                    description: 'Сайт для автосервиса',
                    preview_url: 'https://example.com/previews/myfirstsite2026'
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'landing.site.fullExport',
            [
                'id' => 326,
                'params' => [
                    'edit_mode' => 'Y',
                    'code' => 'myfirstsite2026',
                    'name' => 'Сайт автомастерской',
                    'description' => 'Сайт для автосервиса',
                    'preview_url' => 'https://example.com/previews/myfirstsite2026',
                ],
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Ошибка: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

Обработка ответа

HTTP-статус: 200

{
            "result": {
                "charset": "UTF-8",
                "code": "myfirstsite2026",
                "site_code": "/dgiy8z1opr/",
                "name": "Сайт автомастерской",
                "description": "Сайт для автосервиса",
                "preview": "",
                "preview2x": "",
                "preview3x": "",
                "preview_url": "https://example.com/previews/myfirstsite2026",
                "show_in_list": "Y",
                "type": "page",
                "version": 3,
                "fields": {
                    "ADDITIONAL_FIELDS": {
                        "COOKIES_USE": "N",
                        "B24BUTTON_COLOR": "site",
                        "BACKGROUND_PICTURE": "https://cdn-ru.bitrix24.ru/.../15_1x.jpg",
                        "THEME_USE": "Y"
                    },
                    "TITLE": "Сайт автомастерской",
                    "LANDING_ID_INDEX": "myfirstsite2026",
                    "LANDING_ID_404": "0"
                },
                "layout": [],
                "folders": [],
                "syspages": [],
                "items": {
                    "myfirstsite2026": {
                        "old_id": "2213",
                        "code": "myfirstsite2026",
                        "name": "Сайт автомастерской",
                        "description": "Сайт для автосервиса",
                        "preview": "",
                        "preview2x": "",
                        "preview3x": "",
                        "preview_url": "https://example.com/previews/myfirstsite2026",
                        "show_in_list": "Y",
                        "type": "page",
                        "version": 3,
                        "fields": {
                            "TITLE": "Сайт автомастерской",
                            "RULE": null,
                            "ADDITIONAL_FIELDS": {
                                "B24BUTTON_USE": "N",
                                "METAOG_TITLE": "База отдыха в Карелии Вилла Ранду",
                                "THEME_USE": "N"
                            }
                        },
                        "layout": [],
                        "items": {
                            "#block28175": {
                                "old_id": 28175,
                                "code": "0.menu_02",
                                "access": "X",
                                "anchor": "b2884",
                                "nodes": {
                                    ".landing-block-node-menu-list-item-link": [
                                        {
                                            "href": "#kotteges",
                                            "target": "_self",
                                            "text": "Виллы"
                                        }
                                    ]
                                },
                                "style": {
                                    ".navbar": [
                                        "navbar navbar-expand-lg p-0 g-px-15 u-navbar-align-right"
                                    ]
                                },
                                "attrs": {
                                    ".navbar-collapse": [
                                        {
                                            "id": "navBar2884"
                                        }
                                    ]
                                }
                            }
                        }
                    }
                }
            },
            "time": {
                "start": 1773161828.471138,
                "finish": 1773161828.871144,
                "duration": 0.4000060558319092,
                "processing": 0.10344195365905762,
                "date_start": "2026-03-10T19:57:08+03:00",
                "date_finish": "2026-03-10T19:57:08+03:00",
                "operating_reset_at": 1773162428,
                "operating": 0
            }
        }

Возвращаемые данные

Название `тип`	Описание
result `object` \| `array`	Поля экспортированного сайта. Если сайт не найден в выборке или нет доступных страниц для экспорта, возвращается пустой массив `[]` (подробное описание)
time `time`	Информация о времени выполнения запроса

Объект result

Название `тип`	Описание
charset `string`	Кодировка экспортируемого набора, обычно `UTF-8`
code `string`	Код сайта в экспорте
site_code `string`	Исходный код сайта
name `string`	Название сайта
description `string`	Описание сайта
preview `string`	URL основной превью-картинки
preview2x `string`	URL увеличенной превью-картинки
preview3x `string`	URL retina-превью
preview_url `string`	URL предпросмотра
show_in_list `string`	Флаг отображения в списке шаблонов `Y/N`
type `string`	Тип сайта в нижнем регистре
version `integer`	Версия формата экспорта. Метод возвращает `3`
fields `object`	Поля сайта (подробное описание)
layout `object` \| `array`	Данные шаблона сайта. Если шаблон не привязан, возвращается пустой массив `[]` (подробное описание)
folders `object` \| `array`	Группы страниц по папкам в формате `{"<код_страницы_папки>": ["<код_страницы_1>", "..."]}`. Если папок нет, возвращается `[]`
syspages `object` \| `array`	Системные страницы в формате `{"<тип_системной_страницы>": "<код_страницы>"}`. Если системные страницы не определены, возвращается `[]`
items `object`	Экспорт страниц сайта, где ключ объекта — код страницы (подробное описание)

Объект fields

Название `тип`	Описание
ADDITIONAL_FIELDS `object` \| `array`	Дополнительные поля сайта после фильтрации по `hooks_disable`
TITLE `string`	Заголовок сайта
LANDING_ID_INDEX `string` \| `integer`	Код или идентификатор главной страницы
LANDING_ID_404 `string` \| `integer`	Код или идентификатор страницы `404`

Объект layout

Название `тип`	Описание
code `string`	XML_ID шаблона сайта
ref `string[]`	Коды страниц, связанных с шаблоном сайта

Объект items

Название `тип`	Описание
`<код_страницы>` `object`	Экспорт отдельной страницы (подробное описание)

Объект страницы

Название `тип`	Описание
old_id `integer` \| `string`	Исходный идентификатор страницы
code `string`	Код страницы в экспорте
name `string`	Название страницы
description `string`	Описание страницы
preview `string`	URL основной превью-картинки страницы
preview2x `string`	URL увеличенной превью-картинки страницы
preview3x `string`	URL retina-превью страницы
preview_url `string`	URL предпросмотра страницы
show_in_list `string`	Флаг показа страницы `Y/N`
type `string`	Тип сайта страницы в нижнем регистре
version `integer`	Версия формата экспорта страницы
fields `object`	Поля страницы (подробное описание)
layout `object` \| `array`	Данные шаблона страницы. Если шаблон не привязан, возвращается `[]` (подробное описание)
items `object` \| `array`	Блоки страницы (подробное описание)

Объект fields страницы

Название `тип`	Описание
TITLE `string`	Заголовок страницы
RULE `string` \| `null`	Правило маршрутизации страницы
ADDITIONAL_FIELDS `object` \| `array`	Дополнительные поля страницы после фильтрации по `hooks_disable`

Объект layout страницы

Название `тип`	Описание
code `string`	XML_ID шаблона страницы
ref `string[]`	Коды страниц, связанных с шаблоном страницы

Объект блоков страницы

Название `тип`	Описание
`#block<id>` `object`	Экспорт блока страницы (подробное описание)

Объект блока

Поля блока, которые не содержат данных, удаляются из результата и могут отсутствовать в объекте

Название `тип`	Описание
old_id `integer` \| `string`	Исходный идентификатор блока
code `string`	Код блока
access `string`	Уровень доступа блока
anchor `string`	Локальный якорь блока
repo_block `object`	Данные блока из репозитория (подробное описание)
cards `object`	Экспорт карточек блока
nodes `object`	Экспорт узлов блока
menu `object`	Экспорт меню блока
style `object`	Экспорт стилей блока
attrs `object`	Экспорт атрибутов блока
dynamic `object`	Экспорт динамических параметров блока

Объект repo_block

Название `тип`	Описание
app_code `string`	Код приложения-источника блока
xml_id `string`	XML_ID блока в репозитории

Обработка ошибок

HTTP-статус: 400

{
            "error": "SYSTEM_ERROR",
            "error_description": "Параметр code может состоять только из латинских букв и цифр."
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание
`MISSING_PARAMS`	Не передан обязательный параметр `id`
`ACCESS_DENIED`	Недостаточно прав для доступа к сайтам
`TYPE_ERROR`	Передан параметр неверного типа
`SYSTEM_ERROR`	Внутренняя ошибка выполнения, например `params.code` содержит символы, отличные от латинских букв и цифр

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Удалить сайт

Получить папки сайта

Экспортировать сайт landing.site.fullExport

Параметры методаПараметры метода

Параметр paramsПараметр params

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Объект resultОбъект result

Объект fieldsОбъект fields

Объект layoutОбъект layout

Объект itemsОбъект items

Объект страницыОбъект страницы

Объект fields страницыОбъект fields страницы

Объект layout страницыОбъект layout страницы

Объект блоков страницыОбъект блоков страницы

Объект блокаОбъект блока

Объект repo_blockОбъект repo_block

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение