hosting

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

Take a site into or out of maintenance.

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението sites.view; ключ без него се отхвърля с 403, а не с 404.

Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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> }'

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата

Детайли

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.

Параметри

Име	Тип	Задължително	Какво представлява
`siteId (path)`	`Uuid`	Да	Site ID (UUIDv7).

Тяло на заявката

Име	Тип	Задължително	Какво представлява
`enabled`	`boolean`	Да	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…

Отговор

Име	Тип	Задължително	Какво представлява
`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.

Грешки, които този крайpoint може да върне

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

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