hosting
POST /v1/sites/{siteId}/ssl/external
Install an SSL certificate the customer obtained elsewhere.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão sites.manage; uma chave sem ela é recusada com 403, e não 404.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/ssl/external \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string>, "certificate": <string>, "key": <string>, "ca": <string> }'Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
Installs a third-party certificate against one of the domain names on the site's hosting package, and returns the site's whole TLS state so the client re-renders from the server's answer. The free certificate (`enableSiteFreeSsl`) covers most customers; this is for one they already bought, or an EV/OV certificate their compliance requires. **This endpoint is deliberately stricter than the hosting platform behind it.** The upstream accepts an expired certificate, and one whose names do not include the domain it is installed against, answering success to both — after which every visitor to the site is shown a security warning. Measured against the live platform, 2026-08-21. Both are refused here, `422`, before the upstream is called, because nothing downstream refuses them. Also refused `422`, each in its own words: a private key that does not belong to the certificate, a missing or malformed CA chain, and a certificate that is not yet valid. The upstream reports every one of those as a single undifferentiated server error, which is not something a customer can act on. **The CA chain is required, not optional** — it is the `intermediate` or `chain` file the certificate authority supplies alongside the certificate, and an install without it fails. Unlike the free certificate this is **not** gated on the domain being delegated to us: a supplied certificate needs no validation challenge, so a customer whose DNS lives elsewhere can still use it. That is often exactly why they are here. There is no removal operation, because the platform has none. To go back, request the free certificate again with `enableSiteFreeSsl` — it replaces what is stored. `404` for a site with no vendor hosting package. Requires `sites.manage`.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
siteId (path) | Uuid | Sim | Site ID (UUIDv7). |
Corpo da requisição
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
name | string | Sim | The domain name on the package to install against. It must already be one of the site's names; anything else is refused `422` naming the names that are available, rather than pa… |
certificate | string | Sim | The certificate, PEM-encoded, including its `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----` lines. Surrounding whitespace is normalised rather than rejected — the… |
key | string | Sim | The certificate's private key, PEM-encoded. **Write-only and never returned by any operation**: it is passed to the hosting platform, which stores the bundle, and is not persist… |
ca | string | Sim | The CA chain — the `intermediate` or `chain` file from the certificate authority. May contain several concatenated certificates, and all of them are checked. Required. |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
available | boolean | Sim | 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[] | Sim | The certificates installed on the package. |
force_https | boolean | Sim | 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 | Sim | 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 | Sim | Whether this package type permits changing HTTPS enforcement. |
external_ssl_permitted | boolean | Sim | Whether this package type permits installing a certificate the customer obtained elsewhere (`installSiteExternalSsl`). Reported separately from `free_ssl_permitted` because they… |
Erros que este endpoint pode retornar
401 · 403 · 404 · 409 · 422 · 429 · 503