/config/archive

Метод снимает версию ветки с выдачи. Клиент, который ещё спрашивает это имя, на следующем /config/version получает версию по умолчанию этого сервера.

Вызывается хуком на удаление ветки. Имя, которое ни разу не публиковалось, ошибкой не является.

Адрес метода

/config/archive

Не требует сессию пользователя

Секрет тот же, что у /config/publish: заголовок X-Config-Publish-Secret, настройка config_publish_secret.

Параметры

Параметр Обязательный Тип Описание
version ДА string Имя ветки, 1–191 символ

Результат

{
    "response": {
        "version": "feature/energy-fix",
        "revision": 2,
        "hash": "0123456789abcdef0123456789abcdef",
        "status": "archived",
        "url": "https://cdn.example/0123456789abcdef0123456789abcdef.cdb",
        "unchanged": 0,
        "reimport": 0,
        "archived": 1
    }
}
Поле Тип Описание
archived int 1 — строка архивная (в том числе если она уже была архивной). 0 — строки с таким именем не было, тело ответа содержит только version и archived

Повторный вызов для уже архивной строки безопасен и оставляет archived=1.

Ошибки

Неверный или отсутствующий секрет — 10403 Permission denied.

Версия по умолчанию — 10405, причина в поле details. Сначала назначьте другую версию по умолчанию.