hosting

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

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

Բոլոր hosting վերջնակետերը

Բոլոր մշակողների փաստաթղթերը

Նույնականացում

Ուղարկեք API բանալին որպես bearer token: Բանալին պետք է ունենա 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_hoststring<apex, www>Ոչ
force_httpsbooleanՈչ

Պատասխան

ԱնունՏեսակՊահանջվում էԻնչ է դա
canonical_hoststring<apex, www>Այո
force_httpsbooleanԱյոRedirect http to https at the edge. Defaults to true on every new site.
serves_onstringԱյոThe hostname that actually serves.
redirects_fromstringԱյոThe hostname that permanently redirects to serves_on.
redirect_statusintegerԱյո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_hostsstring[]Այո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_deliverystring<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_deliverablebooleanԱյո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