hosting

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

Turn HTTPS enforcement on or off for a site.

Նույնականացում

Ուղարկեք API բանալին որպես bearer token: Բանալին պետք է ունենա sites.view թույլտվությունը. առանց դրա բանալին մերժվում է 403, և ոչ թե 404 կարգավիճակով:

Այս վերջնակետը կազմակերպության 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)`	`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