hosting
GET /v1/sites/{siteId}/ssl
Get a site's certificates and HTTPS enforcement.
Баталгаажуулалт
API түлхүүрийг bearer token хэлбэрээр илгөэнэ үү. Түлхүүр нь sites.view эрхтэй байх ёстой бөгөөд үүнгүйгээр 404 биш, харин 403 алдаа буцааж татгалзах болно.
Энэ төгсгөл цэг нь ямар ч байгууллагын ID шаардахгүй. Таны түлхүүр аль хэдийн харьяалагдах байгууллагыг тодорхойлж байгаа бөгөөд хариу нь тухайн байгууллагын хүрээнд хязгаарлагдана.
Туршиж үзэх
Өнцөг хаалтанд байгаа бүх зүйлийг өөрийн утгаар солиж, түлхүүр санамж байрлуулагчийг хяналтын самбарынхаа түлхүүрээр сольж оруулна уу.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/ssl \
-H "Authorization: Bearer zdk_live_…"Та нэвтэрсэн байна уу? Таны хяналтын самбар дахь API консол нь таны бодит байгууллагын ID болон өөрийн түлхүүрийг автоматаар бөглөж, шууд ажиллаж буй API рүү хүсэлт илгээх тул та бодит хариуг харах боломжтой болно. Энэ төгсгөлийн цэгийг API консол дээр нээх
Дэлгэрэнгүй
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`.
Параметрүүд
| Нэр | Төрөл | Заавал шаардлагатай | Энэ юу вэ |
|---|---|---|---|
siteId (path) | Uuid | Тийм | Site ID (UUIDv7). |
Хариу үйлдэл
| Нэр | Төрөл | Заавал шаардлагатай | Энэ юу вэ |
|---|---|---|---|
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 pla… |
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 wou… |
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 · 429 · 503