hosting
GET /v1/sites/{siteId}/maintenance-mode
Get whether a site is serving its maintenance page.
Uwierzytelnianie
Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie sites.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.
Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/maintenance-mode \
-H "Authorization: Bearer zdk_live_…"Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
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.
Parametry
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
siteId (path) | Uuid | Tak | Site ID (UUIDv7). |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
available | boolean | Tak | Whether the package exposes maintenance mode at all. False renders an explanation rather than an empty list. |
enabled | boolean | Tak | ⛔ 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[] | Tak | Each alias on the package and its own state. |
permitted | boolean | Tak | Whether the package type includes maintenance mode. An absent vendor capability is a refusal, never an assumption that it is probably on. |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 404 · 429 · 503