hosting

GET /v1/sites/{siteId}/maintenance-mode

Get whether a site is serving its maintenance page.

Все эндпоинты hosting

Аутентификация

Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение sites.view; ключ без него отклоняется с кодом 403, а не 404.

Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/maintenance-mode \
  -H "Authorization: Bearer zdk_live_…"

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли

Подробнее

Whether visitors are being shown the maintenance page instead of the site, per alias. `enabled` is `true` only when **every** alias is in maintenance: one alias still serving is a live site, and a single rounded boolean would hide it from the customer who thinks they took the shop down. `available` says whether the package exposes the control at all, and `permitted` whether the package type includes it, so the client can explain rather than offer a switch whose request is already known to be refused. Requires `sites.view` — whether a site is in maintenance is a fact a support agent needs to answer a ticket, not a secret. `404` for a site with no managed hosting package.

Параметры

ИмяТипОбязательноЧто это
siteId (path)UuidДаSite ID (UUIDv7).

Ответ

ИмяТипОбязательноЧто это
availablebooleanДаWhether the package exposes maintenance mode at all. False renders an explanation rather than an empty list.
enabledbooleanДа⛔ `true` only when **every** alias is in maintenance. One alias still serving is a live site, and a single rounded boolean would hide that from a customer who believes they took…
aliasesSiteMaintenanceAlias[]ДаEach alias on the package and its own state.
permittedbooleanДаWhether the package type includes maintenance mode. An absent vendor capability is a **refusal**, never an assumption that it is probably on.

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 404 · 429 · 503