@salesforce/b2c-tooling-sdk / operations/mrt / UpdateProjectBackendOptions
Interface: UpdateProjectBackendOptions
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:1030
Options for updateProjectWithBackend.
Extends
Properties
allowCookies?
optionalallowCookies:boolean
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:1046
Whether cookies are allowed (SCAPI only).
legacyAuth?
optionallegacyAuth:AuthStrategy
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:824
Legacy API-key auth strategy. Optional; required only when the legacy backend actually runs.
Inherited from
ProjectBackendOptions.legacyAuth
name?
optionalname:string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:1034
New name (legacy only; SCAPI cannot rename a storefront).
onFallback()?
optionalonFallback: (reason) =>void
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:828
Invoked when auto falls back from SCAPI to legacy.
Parameters
reason
string
Returns
void
Inherited from
ProjectBackendOptions.onFallback
onResolve()?
optionalonResolve: (backend) =>void
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:830
Invoked with the backend that serves the call (for -D debug).
Parameters
backend
Returns
void
Inherited from
ProjectBackendOptions.onResolve
origin?
optionalorigin:string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:826
Legacy MRT API origin.
Inherited from
preference
preference:
MrtBackendPreference
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:820
Resolved --mrt-backend preference.
Inherited from
ProjectBackendOptions.preference
preserveProxyUserAgent?
optionalpreserveProxyUserAgent:boolean
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:1048
Whether the end-user User-Agent is preserved through proxies (SCAPI only).
projectSlug
projectSlug:
string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:1032
Project slug (= SCAPI storefront ID) to update.
scapiConnection?
optionalscapiConnection:ScapiMrtConnection
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:822
SCAPI connection; when absent, auto uses legacy and scapi throws.
Inherited from
ProjectBackendOptions.scapiConnection
sites?
optionalsites:string[]
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:1042
Complete replacement set of assigned site IDs (SCAPI only).
ssrArchitecture?
optionalssrArchitecture:"x86"|"arm64"|null
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:1044
New default SSR architecture (SCAPI only); null clears the default.
ssrRegion?
optionalssrRegion:"us-east-1"|"us-east-2"|"us-west-1"|"us-west-2"|"ap-south-1"|"ap-south-2"|"ap-northeast-2"|"ap-southeast-1"|"ap-southeast-2"|"ap-southeast-3"|"ap-northeast-1"|"ap-northeast-3"|"ca-central-1"|"eu-central-1"|"eu-central-2"|"eu-west-1"|"eu-west-2"|"eu-west-3"|"eu-north-1"|"eu-south-1"|"il-central-1"|"me-central-1"|"sa-east-1"
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:1038
New default SSR region, hyphenated legacy form (both backends).
staticIpsDefault?
optionalstaticIpsDefault:boolean
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:1040
New default static-IP setting for new environments (legacy only).
url?
optionalurl:string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/project.ts:1036
New URL (legacy only).