hosting
GET /v1/sites/{siteId}/maintenance-mode
Get whether a site is serving its maintenance page.
Автентифікація
Надішліть ключ 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). |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
available | boolean | Так | Whether the package exposes maintenance mode at all. False renders an explanation rather than an empty list. |
enabled | boolean | Так | ⛔ 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… |
aliases | SiteMaintenanceAlias[] | Так | Each alias on the package and its own state. |
permitted | boolean | Так | 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