SiteSummary
Properties
Section titled “Properties”addressing?
Section titled “addressing?”
optionaladdressing?:SiteAddressing
How this site puts a locale into an address. Absent means invariant — the locale is a separate
locale= parameter and addresses carry none.
createContentClient reads it to decide how to address GET /path and GET /nodes; see
SiteAddressing. An older SDK that does not read this member still matches the site by
hosts — and then sends locale= to a site that refuses it (400 locale_not_addressable), so
move a site off invariant only once its consumers run an SDK that reads it.
deliveryEnvironmentId?
Section titled “deliveryEnvironmentId?”
optionaldeliveryEnvironmentId?:string
The delivery environment this key resolves to — absent against an older server. Once a live
response reveals it, createContentClient sends it back as env= on every later
/sites//locales call in the session, letting the edge serve those requests without reaching
origin at all.
hosts:
string[]
Mapped hostnames (no port). Empty for a site with no host mapping.
locales?
Section titled “locales?”
optionallocales?:LocaleTreeNode[]
The languages this site serves, default first, when it arranges its own (a customized site); absent for a site that follows the
organization’s list from GET /locales. createContentClient chooses a visitor’s locale from this tree rather than the organization’s,
because a customized site refuses a locale it does not serve (400 locale_not_in_site). An older SDK that does not read this member
keeps choosing from the organization’s list, so customize a site only once its consumers run an SDK that reads it.
name:
string
rootNodeId
Section titled “rootNodeId”rootNodeId:
string