hosting
GET /v1/sites/{siteId}/ssl
Get a site's certificates and HTTPS enforcement.
Ìfàṣẹ́pọ̀
Fi bọ́ọ̀lù (bearer token) ranṣẹ gẹ́gẹ́ bí kọ́kọ́rọ́ API. Kọ́kọ́rọ́ náà gbọ́dọ̀ ní ìyọ̀ǹda sites.view; a ó kọ̀ ọ́ silẹ pẹlu 403, kii ṣe 404, ti kọ́kọ́rọ́ náà kò bá ní i.
Ojú abánisọ̀rọ̀ yìí kò gba id ajọ kankan. Kọ́kọ́rọ́ rẹ ti mọ ajọ ti o jẹ ti e, a o si fèsì nipa rẹ̀.
Gbiyanju rẹ
Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/ssl \
-H "Authorization: Bearer zdk_live_…"Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API
Àwọn kúlẹ̀kúlẹ̀
What is actually protecting the site today: the certificates its hosting package holds, and whether plain HTTP is redirected to HTTPS. The free_ssl entitlement has been sold on these packages from the start and, until this resource existed, was read by nothing — a customer paying for a certificate had no surface on which to see whether one had ever been issued. available says whether the package type exposes certificates at all, and the two *_permitted flags say the same thing per action, so the client can explain "your plan does not include this" instead of offering a control whose request would come back refused. An absent vendor capability is a refusal, never an assumption that it is probably on. A site that does not run on a vendor hosting package has no such resource and returns 404, exactly as an out-of-scope or unknown id does — the same policy as getSiteHosting. Requires sites.view.
Àwọn ìpìlẹ̀
| Orúkọ | Iru | Tí a nílò | Kini o jẹ |
|---|---|---|---|
siteId (path) | Uuid | Bẹẹni | Site ID (UUIDv7). |
Idahun
| Orúkọ | Iru | Tí a nílò | Kini o jẹ |
|---|---|---|---|
available | boolean | Bẹẹni | 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[] | Bẹẹni | The certificates installed on the package. |
force_https | boolean | Bẹẹni | 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 | Bẹẹni | 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 | Bẹẹni | Whether this package type permits changing HTTPS enforcement. |
external_ssl_permitted | boolean | Bẹẹni | Whether this package type permits installing a certificate the customer obtained elsewhere (installSiteExternalSsl). Reported separately from free_ssl_permitted because they… |
Awọn aṣiṣe ti ibudo ipari yii le da pada
401 · 403 · 404 · 429 · 503