hosting
GET /v1/sites/{siteId}/maintenance-mode
Get whether a site is serving its maintenance page.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу sites.view; кључ без ње се одбија уз 403, а не 404.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/maintenance-mode \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом 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