hosting

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

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

모든 hosting 엔드포인트

모든 개발자 문서 →

인증

Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 hosting.cdn.manage 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.

이 엔드포인트는 조직 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 and…
`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/AAAA…
`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 healthy,…

이 엔드포인트가 반환할 수 있는 오류

401 · 403 · 404 · 422 · 429

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

인증