hosting

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

Get whether a site is serving its maintenance page.

Toate punctele finale hosting

Autentificare

Trimiteți o cheie API ca token de tip bearer. Cheia trebuie să aibă permisiunea sites.view; o cheie care nu o are va fi respinsă cu 403, nu 404.

Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.

Încearcă

Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.

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

Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API

Detalii

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.

Parametri

NumeTipObligatoriuCe este
siteId (path)UuidDaSite ID (UUIDv7).

Răspuns

NumeTipObligatoriuCe este
availablebooleanDaWhether the package exposes maintenance mode at all. False renders an explanation rather than an empty list.
enabledbooleanDa⛔ `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[]DaEach alias on the package and its own state.
permittedbooleanDaWhether the package type includes maintenance mode. An absent vendor capability is a **refusal**, never an assumption that it is probably on.

Erori pe care le poate returna acest punct final

401 · 403 · 404 · 429 · 503