hosting

PATCH `/v1/sites/{siteId}/cdn/canonical-host`

Choose www or non-www, and whether to force HTTPS.

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 hosting.cdn.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

curl -X PATCH https://api.zinndigital.com/v1/sites/{siteId}/cdn/canonical-host \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。在 API 控制台中打开此端点

详细信息

A **merge**: only the fields present in the body change. An absent field is left alone rather than reset, so a client written before one of these existed cannot switch it off on every save. `force_https` defaults to `true` on every new site. The insecure choice has to be made explicitly; it is never reached by omitting a field. A site whose primary domain is a **deeper subdomain** (`shop.blog.example.com`) has no `www` counterpart, and the request is a `422` rather than a stored preference whose plan can never be built. Refusing at write time is deliberate: the alternative saves cleanly and then fails later inside provisioning, where the customer sees a stuck deploy instead of the bad input. An empty body is a `422`, not a no-op success. Requires `hosting.cdn.manage`.

参数

名称	类型	必填	内容简介
`siteId (path)`	`Uuid`	是	Site ID (UUIDv7).

请求正文

名称	类型	必填	内容简介
`canonical_host`	`string<apex, www>`	否	—
`force_https`	`boolean`	否	—

响应

名称	类型	必填	内容简介
`canonical_host`	`string<apex, www>`	是	—
`force_https`	`boolean`	是	Redirect http to https at the edge. Defaults to true on every new site.
`serves_on`	`string`	是	The hostname that actually serves.
`redirects_from`	`string`	是	The hostname that permanently redirects to `serves_on`.
`redirect_status`	`integer`	是	Always 301. A 302 tells search engines to keep indexing the alias, which leaves the duplicate-content problem unsolved while looking correct in a browser.
`certificate_hosts`	`string[]`	是	Both hostnames, always. TLS is negotiated on the name being redirected from, so a certificate covering only `serves_on` puts a security interstitial in front of the alias an…
`apex_delivery`	`string<native, alias, a_records, unsupported>`	是	How the zone apex is made to resolve. A bare apex cannot be a `CNAME`, so on a pull-zone CDN it resolves only through CNAME-flattening/ALIAS at the DNS provider, or through A/AA…
`apex_deliverable`	`boolean`	是	`false` when neither mechanism is available for this CDN/DNS pairing. The combination is refused rather than accepted, because the alternative provisions cleanly, reports health…

此端点可能返回的错误

401 · 403 · 404 · 422 · 429

PATCH /v1/sites/{siteId}/cdn/canonical-host