---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../../modules.md) / [operations/mrt](../index.md) / CreateEnvironmentBackendOptions

# Interface: CreateEnvironmentBackendOptions

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1553](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/env.ts#L1553)

Options for [createEnvironmentWithBackend](../functions/createEnvironmentWithBackend.md).

## Extends

- [`EnvBackendOptions`](EnvBackendOptions.md)

## Properties

### allowCookies?

> `optional` **allowCookies**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1574](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/env.ts#L1574)

Forward cookies to origin (legacy only).

***

### enableSourceMaps?

> `optional` **enableSourceMaps**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1576](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/env.ts#L1576)

Enable source maps (legacy only).

***

### externalDomain?

> `optional` **externalDomain**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1572](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/env.ts#L1572)

External domain (legacy only).

***

### externalHostname?

> `optional` **externalHostname**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1570](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/env.ts#L1570)

Full external hostname (legacy only).

***

### hostname?

> `optional` **hostname**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1568](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/env.ts#L1568)

Hostname pattern for V8 Tag loading (legacy only).

***

### isProduction?

> `optional` **isProduction**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1566](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/env.ts#L1566)

Mark as a production environment (legacy only).

***

### legacyAuth?

> `optional` **legacyAuth**: [`AuthStrategy`](../../../auth/interfaces/AuthStrategy.md)

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1450](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/env.ts#L1450)

Legacy API-key auth strategy. Optional; required only when the legacy backend actually runs.

#### Inherited from

[`EnvBackendOptions`](EnvBackendOptions.md).[`legacyAuth`](EnvBackendOptions.md#legacyauth)

***

### logLevel?

> `optional` **logLevel**: `"TRACE"` \| `"DEBUG"` \| `"INFO"` \| `"WARN"` \| `"ERROR"` \| `"FATAL"`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1580](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/env.ts#L1580)

Minimum log level (legacy only).

***

### name?

> `optional` **name**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1560](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/env.ts#L1560)

Display name for the new environment. SCAPI requires it (the only field it
accepts on create); legacy defaults it to the slug. Optional here so each
backend branch validates it — SCAPI throws a MrtScapiPreconditionError
when absent so `auto` can fall back to legacy.

***

### onFallback()?

> `optional` **onFallback**: (`reason`) => `void`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1456](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/env.ts#L1456)

Invoked when `auto` falls back from SCAPI to legacy.

#### Parameters

##### reason

`string`

#### Returns

`void`

#### Inherited from

[`EnvBackendOptions`](EnvBackendOptions.md).[`onFallback`](EnvBackendOptions.md#onfallback)

***

### onResolve()?

> `optional` **onResolve**: (`backend`) => `void`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1458](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/env.ts#L1458)

Invoked with the backend that serves the call (for `-D` debug).

#### Parameters

##### backend

[`MrtBackend`](../type-aliases/MrtBackend.md)

#### Returns

`void`

#### Inherited from

[`EnvBackendOptions`](EnvBackendOptions.md).[`onResolve`](EnvBackendOptions.md#onresolve)

***

### origin?

> `optional` **origin**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1454](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/env.ts#L1454)

Legacy MRT API origin.

#### Inherited from

[`EnvBackendOptions`](EnvBackendOptions.md).[`origin`](EnvBackendOptions.md#origin)

***

### preference

> **preference**: [`MrtBackendPreference`](../type-aliases/MrtBackendPreference.md)

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1446](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/env.ts#L1446)

Resolved `--mrt-backend` preference.

#### Inherited from

[`EnvBackendOptions`](EnvBackendOptions.md).[`preference`](EnvBackendOptions.md#preference)

***

### projectSlug

> **projectSlug**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1452](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/env.ts#L1452)

Project slug (= SCAPI storefront ID).

#### Inherited from

[`EnvBackendOptions`](EnvBackendOptions.md).[`projectSlug`](EnvBackendOptions.md#projectslug)

***

### proxyConfigs?

> `optional` **proxyConfigs**: `object`[]

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1584](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/env.ts#L1584)

Proxy configurations (legacy only).

#### host

> **host**: `string`

#### path

> **path**: `string`

***

### region?

> `optional` **region**: `"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/env.ts:1564](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/env.ts#L1564)

Default SSR region, hyphenated legacy form (legacy only).

***

### scapiConnection?

> `optional` **scapiConnection**: [`ScapiMrtConnection`](ScapiMrtConnection.md)

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1448](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/env.ts#L1448)

SCAPI connection; when absent, `auto` uses legacy and `scapi` throws.

#### Inherited from

[`EnvBackendOptions`](EnvBackendOptions.md).[`scapiConnection`](EnvBackendOptions.md#scapiconnection)

***

### slug?

> `optional` **slug**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1562](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/env.ts#L1562)

Environment slug (legacy only; SCAPI generates the environment ID).

***

### ssrStaticIps?

> `optional` **ssrStaticIps**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1578](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/env.ts#L1578)

Make outbound requests from static IPs (legacy only).

***

### whitelistedIps?

> `optional` **whitelistedIps**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/env.ts:1582](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/8fc17d8708d025c83fb0c44ca73198a200605153/packages/b2c-tooling-sdk/src/operations/mrt/env.ts#L1582)

IP whitelist, space-separated CIDR blocks (legacy only).