hosting

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

Turn HTTPS enforcement on or off for a site.

모든 hosting 엔드포인트

모든 개발자 문서

인증

Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 sites.view 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.

이 엔드포인트는 조직 ID를 받지 않습니다. 사용자의 키가 이미 속한 조직을 식별하며, 응답은 해당 조직으로 한정됩니다.

무료 체험하기

대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.

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 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 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)UuidSite ID (UUIDv7).

요청 본문

이름유형필수설명
enabledbooleanWhether 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…

응답

이름유형필수설명
availablebooleanWhether 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"…
certificatesSiteSslCertificate[]The certificates installed on the package.
force_httpsbooleanWhether 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_permittedbooleanWhether 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_permittedbooleanWhether this package type permits changing HTTPS enforcement.
external_ssl_permittedbooleanWhether 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