hosting

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

Take a site into or out of maintenance.

Autentikasi

Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin sites.view; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.

Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

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

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Detail

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.

Parameter

Nama	Jenis	Wajib	Tentang apa ini
`siteId (path)`	`Uuid`	Ya	Site ID (UUIDv7).

Isi permintaan

Nama	Jenis	Wajib	Tentang apa ini
`enabled`	`boolean`	Ya	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…

Tanggapan

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

Kesalahan yang dapat dikembalikan oleh titik akhir ini

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

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