hosting

PUT `/v1/sites/{siteId}/ssl/force`

Turn HTTPS enforcement on or off for a site.

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл sites.view; ключ без нього відхиляється з кодом 403, а не 404.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

Sets whether every plain-HTTP request to the site is redirected to HTTPS, and returns the site's whole TLS 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. Turning enforcement on while no certificate is installed is refused 422 rather than accepted, because the redirect would send every visitor to a URL the browser then rejects — the site is not merely unchanged, it is unreachable. A package type that does not permit the setting is refused 422 before the vendor is called. 404 for a site with no vendor hosting package. Requires sites.view and hosting.ssl.manage.

Параметри

Назва	Тип	Обов'язкове	Що це таке
`siteId (path)`	`Uuid`	Так	Site ID (UUIDv7).

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`enabled`	`boolean`	Так	Whether plain HTTP should be redirected to HTTPS. There is no third value: `getSiteSsl` may report `force_https` as null when the package does not publish the setting, but a…

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`available`	`boolean`	Так	Whether the package type exposes a certificate surface at all. False renders an explanation rather than an empty list, so "nothing has been issued yet" and "not part of this plan"…
`certificates`	`SiteSslCertificate[]`	Так	The certificates installed on the package.
`force_https`	`boolean`	Так	Whether plain HTTP is redirected to HTTPS, or null when the package does not report the setting. Null is a third state the client must render as unknown: an unchecked toggle would…
`free_ssl_permitted`	`boolean`	Так	Whether this package type permits requesting the free certificate. An absent vendor capability means refused, never "probably on" — the refusal is ours, in our words, before…
`force_ssl_permitted`	`boolean`	Так	Whether this package type permits changing HTTPS enforcement.
`external_ssl_permitted`	`boolean`	Так	Whether this package type permits installing a certificate the customer obtained elsewhere (`installSiteExternalSsl`). Reported separately from `free_ssl_permitted` because they…

Помилки, які може повертати ця кінцева точка

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

PUT /v1/sites/{siteId}/ssl/force