hosting

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

Take a site into or out of maintenance.

Autentifikatsiya

API kalitini bearer token sifatida yuboring. Kalit sites.view ruxsatiga ega boʻlishi shart; ruxsatsiz kalit 404 emas, balki 403 xatosi bilan rad etiladi.

Bu yakuniy nuqta hech qanday tashkilot identifikatorini qabul qilmaydi. Sizning kalitingiz unga tegishli tashkilotni allaqachon aniqlaydi va javob shunga qarab cheklanadi.

Sinab ko'rish

Qavslardagi har qanday narsani o'z qiymatlaringiz bilan, kalit pleysxolderini эsa boshqaruv panelingizdagi kalit bilan almashtiring.

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

Tizimga kirganmisiz? Boshqaruv panelingizdagi API konsoli haqiqiy tashkilot ID raqamingiz va shaxsiy kalitingizni avtomatik to'ldiradi hamda haqiqiy javobni ko'rishingiz uchun so'rovni jonli API orqali bajaradi. Ushbu yakuniy nuqtani API konsolida oching

Tafsilotlar

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.

Parametrlar

Nomi	Turi	Majburiy	Nima bu
`siteId (path)`	`Uuid`	Ha	Site ID (UUIDv7).

Soʻrov tanasi

Nomi	Turi	Majburiy	Nima bu
`enabled`	`boolean`	Ha	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…

Javob

Nomi	Turi	Majburiy	Nima bu
`available`	`boolean`	Ha	Whether the package exposes maintenance mode at all. False renders an explanation rather than an empty list.
`enabled`	`boolean`	Ha	⛔ `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[]`	Ha	Each alias on the package and its own state.
`permitted`	`boolean`	Ha	Whether the package type includes maintenance mode. An absent vendor capability is a refusal, never an assumption that it is probably on.

Ushbu yakuniy nuqta qaytarishi mumkin bo'lgan xatolar

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

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