@salesforce/b2c-tooling-sdk / operations/mrt / UpdateEnvironmentBackendOptions
Interface: UpdateEnvironmentBackendOptions
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1813
Options for updateEnvironmentWithBackend.
Extends
Properties
allowCookies?
optionalallowCookies:boolean|null
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1827
Forward cookies to origin (legacy only).
enableSourceMaps?
optionalenableSourceMaps:boolean|null
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1831
Enable source maps (legacy only).
environment
environment:
string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1815
Environment slug (= SCAPI environment ID) to update.
externalDomain?
optionalexternalDomain:string|null
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1825
External domain (legacy only).
externalHostname?
optionalexternalHostname:string|null
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1823
Full external hostname (legacy only).
hostname?
optionalhostname:string|null
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1821
Hostname pattern for V8 Tag loading (legacy only).
isProduction?
optionalisProduction:boolean
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1819
Mark as a production environment (legacy only).
legacyAuth?
optionallegacyAuth:AuthStrategy
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1450
Legacy API-key auth strategy. Optional; required only when the legacy backend actually runs.
Inherited from
logLevel?
optionallogLevel:"TRACE"|"DEBUG"|"INFO"|"WARN"|"ERROR"|"FATAL"|null
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1835
Minimum log level (legacy only).
name?
optionalname:string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1817
New display name for the environment (both backends).
onFallback()?
optionalonFallback: (reason) =>void
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1456
Invoked when auto falls back from SCAPI to legacy.
Parameters
reason
string
Returns
void
Inherited from
onResolve()?
optionalonResolve: (backend) =>void
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1458
Invoked with the backend that serves the call (for -D debug).
Parameters
backend
Returns
void
Inherited from
origin?
optionalorigin:string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1454
Legacy MRT API origin.
Inherited from
preference
preference:
MrtBackendPreference
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1446
Resolved --mrt-backend preference.
Inherited from
preserveProxyUserAgent?
optionalpreserveProxyUserAgent:boolean|null
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1829
Forward the original client User-Agent header to proxy origins (legacy only).
projectSlug
projectSlug:
string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1452
Project slug (= SCAPI storefront ID).
Inherited from
proxyConfigs?
optionalproxyConfigs:object[] |null
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1839
Proxy configurations (legacy only).
scapiConnection?
optionalscapiConnection:ScapiMrtConnection
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1448
SCAPI connection; when absent, auto uses legacy and scapi throws.
Inherited from
EnvBackendOptions.scapiConnection
ssrStaticIps?
optionalssrStaticIps:boolean
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1833
Make outbound requests from static IPs (legacy only).
whitelistedIps?
optionalwhitelistedIps:string|null
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1837
IP whitelist, space-separated CIDR blocks (legacy only).