hosting

PUT `/v1/sites/{siteId}/maintenance-mode`

Take a site into or out of maintenance.

Autentifikimi

Drgoni një çelës API si një token mbajtës. Çelësi duhet të ketë lejen sites.view; një çelës pa të refuzohet me 403, jo 404.

Ky pikëndalim nuk pranon id të organizatës. Çelësi juaj tashmë identifikon organizatën së cilës i përket dhe përgjigjja kufizohet vetëm për atë.

Provoje

Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.

curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/maintenance-mode \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "enabled": <boolean> }'

Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së

Detajet

Switches every alias at once and returns the whole new state, so the client re-renders from the server's answer rather than from what it asked for. `PUT` because the body states the desired end state: sending the same value twice is the same site. ⛔ The customer's own maintenance-page HTML travels with the vendor's row, and this operation carries it through unchanged. A toggle built from scratch blanks it, replacing a page the customer wrote with a default one — which is why the write reads the existing row first. Turning it **on** takes the site off the internet for every visitor, so the client confirms before calling. Requires `sites.view` **and** `sites.panel_access`. `404` for a site with no managed hosting package.

Parametrat

Emri	Lloji	Kërkohet	Çfarë është kjo
`siteId (path)`	`Uuid`	Po	Site ID (UUIDv7).

Trupi i kërkesës

Emri	Lloji	Kërkohet	Çfarë është kjo
`enabled`	`boolean`	Po	Whether visitors should be shown the maintenance page. There is no third value: `getSiteMaintenanceMode` may report a mixed set of aliases, but a caller asking to change it must…

Përgjigja

Emri	Lloji	Kërkohet	Çfarë është kjo
`available`	`boolean`	Po	Whether the package exposes maintenance mode at all. False renders an explanation rather than an empty list.
`enabled`	`boolean`	Po	⛔ `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[]`	Po	Each alias on the package and its own state.
`permitted`	`boolean`	Po	Whether the package type includes maintenance mode. An absent vendor capability is a refusal, never an assumption that it is probably on.

Gabimet që ky pikëndalim mund të kthejë

401 · 403 · 404 · 409 · 422 · 429 · 503

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