hosting
POST /v1/sites/{siteId}/ssl/external
Install an SSL certificate the customer obtained elsewhere.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 sites.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
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> }'已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
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`.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
siteId (path) | Uuid | 是 | Site ID (UUIDv7). |
请求正文
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
name | string | 是 | 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 | 是 | The certificate, PEM-encoded, including its `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----` lines. Surrounding whitespace is normalised rather than rejected — the… |
key | string | 是 | 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 | 是 | The CA chain — the `intermediate` or `chain` file from the certificate authority. May contain several concatenated certificates, and all of them are checked. Required. |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
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 · 409 · 422 · 429 · 503