hosting

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

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

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) hosting.cdn.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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`.

Paraméterek

Név	Típus	Kötelező	Mi ez
`siteId (path)`	`Uuid`	Igen	Site ID (UUIDv7).

Kérés törzse

Név	Típus	Kötelező	Mi ez
`canonical_host`	`string<apex, www>`	Nem	—
`force_https`	`boolean`	Nem	—

Válasz

Név	Típus	Kötelező	Mi ez
`canonical_host`	`string<apex, www>`	Igen	—
`force_https`	`boolean`	Igen	Redirect http to https at the edge. Defaults to true on every new site.
`serves_on`	`string`	Igen	The hostname that actually serves.
`redirects_from`	`string`	Igen	The hostname that permanently redirects to `serves_on`.
`redirect_status`	`integer`	Igen	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[]`	Igen	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>`	Igen	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`	Igen	`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…

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 422 · 429

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