Сайты и домены
Ручки /sites относятся к сети, а не к сайту: префикса /site/{siteId} у них нет, и blog_id, заголовок и domain запроса они не читают — сайт называется {id} в пути. {id} — site_id или номер блога, принимается и то и другое.
| Ручка | Кому доступна |
|---|---|
GET /sites/{id} | администратору этого сайта и суперадмину; остальным — 404 site_not_found |
POST /sites | суперадмину сети |
POST /sites/{id}/domain | суперадмину сети |
DELETE /sites/{id} | суперадмину сети |
POST /sites/{id}/restore | суперадмину сети |
Номера сайтов в примерах ниже условные — подставляйте свои. Администратор сайта на сетевых операциях получает 403 insufficient_role с текстом network super admin required: они переписывают реестр сети, а не опции сайта.
Карточка сайта
curl -s -H "Authorization: Bearer $OP_TOKEN" "$API/sites/233" | jq '{site_id, blog_id, domain, home, is_super_admin, realm, public, blog_public, theme, show_on_front, page_on_front, languages, counts: .counts | {pages, menus, frames, datasets}}'{
"site_id": "x9HTLHECq",
"blog_id": 233,
"domain": "test.onpress.pro",
"home": "https://test.onpress.pro",
"is_super_admin": true,
"realm": "prod",
"public": 1,
"blog_public": 1,
"theme": { "template": "onpress-v2", "stylesheet": "onpress-v2", "current_theme": "onpress-v2" },
"show_on_front": "page",
"page_on_front": 5776,
"languages": { "default": "en", "list": ["en", "ru"] },
"counts": { "pages": 101, "menus": 14, "frames": 23, "datasets": 4 }
}Отсюда берут site_id для адресов /api/v2/site/{site_id}/…. Ещё в карточке: archived, deleted (флаги сети), registered, last_updated, blogname, blogdescription, site_icon, instance_realm (какой экземпляр API ответил) и counts.post_types — сколько записей каждого типа. Списка сайтов в v2 нет; все свои сайты с номерами отдаёт GET https://onpress.pro/wp-json/onpress/v1/sites с тем же токеном (data[].id).
Создать сайт
Новый сайт — клон сайта-донора. С empty: true из клона удаляется всё содержимое, остаётся «дизайн»: тема, языки, токены, собственный CSS и выбранные фреймы.
curl -s -X POST "$API/sites" \
-H "Authorization: Bearer $OP_TOKEN" -H 'Content-Type: application/json' \
-d '{
"name": "pomelli",
"title": "Pomelli",
"donor": 233,
"empty": true,
"keep_frames": ["site__header", "site__footer", "article"],
"copy_files": false,
"public": false
}' | jq '{site_id, blog_id, domain, realm, purged: .purged | {pages, menus, datasets, frames, frames_kept, frames_missing}}'{
"site_id": "LBmdCw6ri",
"blog_id": 241,
"domain": "pomelli.onpress.pro",
"realm": "prod",
"purged": { "pages": 21, "menus": 6, "datasets": 4, "frames": 20, "frames_kept": { "cb7ccee58078d1fb": "site__header" }, "frames_missing": [] }
}| Поле | Смысл |
|---|---|
name | поддомен: латиница в нижнем регистре, цифры и дефисы, до 50 символов; нельзя www, api, admin, mail, ftp, cdn, static, app, apps, stage, test. Сайт получит <name>.onpress.pro |
title | название; по умолчанию name |
donor | номер блога сайта-донора |
empty | очистить содержимое после клона; по умолчанию false |
keep_frames | массив слагов или id фреймов, которые сохранить при empty: true; одиночное значение или true — 400 invalid_keep_frames; без empty: true — тоже ошибка |
copy_files | копировать загрузки донора; по умолчанию true. С empty: true передавайте false — на файлы не останется ссылок |
public | false — сразу закрыть от поисковиков; не указано — как у донора |
Что удаляет empty (только в таблицах нового сайта): все записи любых типов с метой и связями, группы переводов, меню и их привязки, приложения, наборы данных, фреймы вне keep_frames с их копиями, служебные кэши, индексы Yoast, настройки и счётчики аналитики донора, состояние мастера домена; главная, страница блога, иконка и логотип обнуляются. Что остаётся: тема, языки и настройки Polylang, собственный CSS и токены, пользователи и роли, сохранённые фреймы.
Клон идёт синхронно, десятки секунд (ожидание до 300 с). Сайт с тем же доменом — 409 site_exists с его blog_id: повторять безопасно. Другие ответы: 400 invalid_name, 400 invalid_donor, 404 donor_not_found, 500 purge_failed (клон создан, blog_id в ответе, очистка остановилась, за пределы нового сайта ничего не вышло).
Сайт помечается контуром создавшего его экземпляра API (realm). После создания: страницы нового сайта собираются из исходников сохранённых фреймов, поэтому сразу показывают свои меню и данные; только статические копии остаются от донора до пересборки — после настройки меню и данных вызовите POST /frames/rebake {"all": true}.
Домен сайта
Эта ручка переводит сайт на домен, который сеть уже обслуживает, — например обменивает домены двух сайтов. Регистратор, DNS, веб-сервер и сертификаты она не трогает. Подключить к сети новый внешний домен — это раздел «Домен» дашборда (мастер: DNS, SSL, применение) или ручки первой версии /wp-json/onpress/v1/domain/*.
Назначить свободный домен:
curl -s -X POST "$API/sites/241/domain" \
-H "Authorization: Bearer $OP_TOKEN" -H 'Content-Type: application/json' \
-d '{"domain": "pomelli.help", "dry_run": true}' | jq .Обменять домены двух сайтов — сайт из пути забирает domain у swap_with, а тот получает нынешний домен сайта из пути, одним атомарным вызовом:
curl -s -X POST "$API/sites/241/domain" \
-H "Authorization: Bearer $OP_TOKEN" -H 'Content-Type: application/json' \
-d '{"domain": "pomelli.help", "swap_with": 240}' | jq '{mode, changed, sites: [.sites[] | {blog_id, domain, home, stale}], warnings}'| Поле | По умолчанию | Смысл |
|---|---|---|
domain | — | только имя хоста, минимум два уровня, до 253 символов; схема, порт и путь отбрасываются |
swap_with | — | второй сайт обмена (номер или site_id); должен владеть domain прямо сейчас |
dry_run | false | вернуть план и ничего не менять |
stale_report | true | посчитать, сколько строк ещё содержат старый домен (sites[].stale) |
flush | true | сбросить кэши обоих сайтов |
rebake | true | пересобрать все фреймы обоих сайтов — в копиях абсолютные адреса |
Что делается с каждым сайтом: home и siteurl переписываются на новый хост, правила адресов и кэши языков сбрасываются, каталоги кэша страниц старого и нового хоста чистятся, затем на новом домене сайта SEO и языки перечитывают адреса, сбрасываются кэши и пересобираются фреймы. Настройка мастера домена (onpress_domain) переезжает вместе с доменом — поле domain_option. Тексты страниц не переписываются: картинки в v2 пишутся путями от корня, а остатки старого хоста посчитаны в stale.
Повтор того же вызова безопасен и доводит прерванный: домен уже на месте — changed: false, строки не двигаются, но адреса и кэши приводятся в порядок. Отката нет: обратный вызов с переставленными сайтами возвращает всё назад.
| Код | HTTP | Когда |
|---|---|---|
invalid_domain | 400 | не имя хоста |
invalid_swap_with | 400 | не номер сайта или сам сайт |
unknown_field | 400 | лишнее поле |
site_not_found | 404 | нет такого сайта |
site_deleted | 409 | сайт помечен удалённым |
main_site_locked | 409 | главный сайт сети домен не меняет, домен сети не отдаётся сайту |
domain_taken | 409 | домен у другого сайта, а swap_with не указан; владелец в blog_id |
swap_domain_mismatch | 409 | swap_with сейчас не владеет domain |
domain_busy | 409 | идёт другая смена домена |
domain_changed_meanwhile | 409 | домен сдвинулся между планом и блокировкой |
domain_move_failed | 500 | ядро отказало; сделанные шаги откачены (rolled_back, done) |
internal_unavailable | 502 | исполнитель не ответил за 120 с |
Снять с эфира и удалить
Два режима, безопасный — по умолчанию:
mode | Что происходит |
|---|---|
archive | сайт снят с эфира, всё цело: флаги deleted и archived, закрыт от поисковиков, статические копии и кэш страниц убраны (иначе веб-сервер продолжал бы отдавать копии). Таблицы, файлы и запись сайта остаются. Возвращается POST /sites/{id}/restore |
purge | всё: таблицы сайта, файлы, приложения, статика, кэш, запись в реестре сети, ключи пользователей. Необратимо |
# план архивации
curl -s -X DELETE "$API/sites/247" \
-H "Authorization: Bearer $OP_TOKEN" -H 'Content-Type: application/json' \
-d '{"dry_run": true}' | jq '{mode, plan: .plan | {domain, tables_count, content, users, confirm_required, confirm_with}}'
# полное удаление: сначала план, потом с подтверждением доменом
curl -s -X DELETE "$API/sites/247" \
-H "Authorization: Bearer $OP_TOKEN" -H 'Content-Type: application/json' \
-d '{"mode": "purge", "dry_run": true}' | jq '.plan.confirm_with'
curl -s -X DELETE "$API/sites/247" \
-H "Authorization: Bearer $OP_TOKEN" -H 'Content-Type: application/json' \
-d '{"mode": "purge", "confirm": "agentdel1.onpress.pro"}' | jq '{mode, verify}'| Поле | Смысл |
|---|---|
mode | archive (по умолчанию) или purge |
dry_run | план без изменений |
confirm | домен сайта; обязателен для purge непустого сайта (точная строка — в plan.confirm_with) |
drop_orphan_users | при purge удалить учётные записи, которые состоят только в этом сайте (суперадмины и пользователь 1 не удаляются никогда) |
Пустой сайт (нет страниц, записей, вложений, приложений и файлов) удаляется без confirm; иначе — 428 confirmation_required с планом. Главный сайт сети не удаляется никогда — 409 main_site_protected. Перед удалением таблиц каждое имя проверяется на принадлежность именно этому сайту; не прошедшие проверку перечислены в plan.tables_rejected и не трогаются. Ответ purge несёт verify — сверку после работы: сколько таблиц осталось, не задеты ли соседние сайты. Заказы и журналы оплат сети сохраняются.
Другие ответы: 400 invalid_mode, 400 unknown_field, 400 invalid_drop_orphan_users (без purge), 404 site_not_found, 409 site_already_gone (archive сайта без записи в реестре), 500 unsafe_table.
Вернуть на эфир
curl -s -X POST "$API/sites/248/restore" -H "Authorization: Bearer $OP_TOKEN" | jq '{blog_id, domain, archived, deleted, public, restored_from, rebake: .rebake.status}'Снимает флаги архива, возвращает прежнюю видимость и пересобирает фреймы, чтобы вернулись статические копии. Неудачная пересборка не отменяет возврат — повторите вызов. После purge возвращать нечего — 404 site_not_found.