hosting
POST /v1/sites/{siteId}/ssl
Request the free certificate for a site.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението sites.manage; ключ без него се отхвърля с 403, а не с 404.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/ssl \
-H "Authorization: Bearer zdk_live_…"Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
Asks the vendor to issue the free certificate the package includes, then returns the site's TLS state as `getSiteSsl` would. It returns `200` and the whole resource rather than `201` and a certificate, because issuance is not instant: what the customer needs back is the state of the thing they were looking at, and the certificate appears in it once the authority has answered. Issuing again while a certificate is already valid is not an error — the request is safe to repeat, which matters because the customer's most likely next action after seeing nothing happen is to press the button again. A package type that does not permit free certificates is refused `422` **before** the vendor is called, with our sentence rather than a vendor error string. `404` for a site with no vendor hosting package, exactly as `getSiteHosting`. Requires `sites.manage`.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
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… |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 409 · 422 · 429 · 503