hosting
POST /v1/sites/{siteId}/ssl
Request the free certificate for a site.
Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění sites.view; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/ssl \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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.view and hosting.ssl.manage.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
siteId (path) | Uuid | Ano | Site ID (UUIDv7). |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
available | boolean | Ano | 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[] | Ano | The certificates installed on the package. |
force_https | boolean | Ano | 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 | Ano | 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 | Ano | Whether this package type permits changing HTTPS enforcement. |
external_ssl_permitted | boolean | Ano | Whether this package type permits installing a certificate the customer obtained elsewhere (installSiteExternalSsl). Reported separately from free_ssl_permitted because they… |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404 · 409 · 422 · 429 · 503