hosting

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

Get whether a site is serving its maintenance page.

Minden hosting végpont

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) sites.view jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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.

Paraméterek

NévTípusKötelezőMi ez
siteId (path)UuidIgenSite ID (UUIDv7).

Válasz

NévTípusKötelezőMi ez
availablebooleanIgenWhether the package exposes maintenance mode at all. False renders an explanation rather than an empty list.
enabledbooleanIgen⛔ `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[]IgenEach alias on the package and its own state.
permittedbooleanIgenWhether the package type includes maintenance mode. An absent vendor capability is a **refusal**, never an assumption that it is probably on.

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 429 · 503