hosting

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

Get whether a site is serving its maintenance page.

تصدیق‌هویت

یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د sites.view اجازه ولري؛ له دې اجازې پرته کی د 404 پرځای د 403 په واسطه رد کیږي.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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

ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د API په کنسول کې پرانیزئ

تفصیلات

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.

پارامترونه

نوم	ډول	اړین	دا څه شی دی
`siteId (path)`	`Uuid`	هو	Site ID (UUIDv7).

ځواب

نوم	ډول	اړین	دا څه شی دی
`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.

تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي

401 · 403 · 404 · 429 · 503

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