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

[@salesforce/b2c-tooling-sdk](../../modules.md) / [instance](../index.md) / InstanceConfig

# Interface: InstanceConfig

Defined in: [packages/b2c-tooling-sdk/src/instance/index.ts:86](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/instance/index.ts#L86)

Instance configuration (hostname, code version, etc.)

## Properties

### apiBackend?

> `optional` **apiBackend**: `"ocapi"` \| `"scapi"` \| `"auto"`

Defined in: [packages/b2c-tooling-sdk/src/instance/index.ts:110](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/instance/index.ts#L110)

Backend preference for operations that support both OCAPI (legacy) and
SCAPI. Defaults to `'auto'` when unset. Lets the instance answer "should
this operation prefer SCAPI?" without the caller re-reading config.

***

### codeVersion?

> `optional` **codeVersion**: `string`

Defined in: [packages/b2c-tooling-sdk/src/instance/index.ts:90](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/instance/index.ts#L90)

Code version for deployments

***

### hostname

> **hostname**: `string`

Defined in: [packages/b2c-tooling-sdk/src/instance/index.ts:88](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/instance/index.ts#L88)

B2C instance hostname

***

### shortCode?

> `optional` **shortCode**: `string`

Defined in: [packages/b2c-tooling-sdk/src/instance/index.ts:99](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/instance/index.ts#L99)

SCAPI short code (e.g. `kv7kzm78`). Required, together with [tenantId](#tenantid),
to reach the Salesforce Commerce API. Populated from resolved configuration.

***

### tenantId?

> `optional` **tenantId**: `string`

Defined in: [packages/b2c-tooling-sdk/src/instance/index.ts:104](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/instance/index.ts#L104)

SCAPI tenant/organization ID (e.g. `zzxy_prd`). Required, together with
[shortCode](#shortcode), to reach the Salesforce Commerce API.

***

### tlsOptions?

> `optional` **tlsOptions**: [`TlsOptions`](../../clients/interfaces/TlsOptions.md)

Defined in: [packages/b2c-tooling-sdk/src/instance/index.ts:94](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/instance/index.ts#L94)

TLS options for mTLS/self-signed certificate support

***

### webdavHostname?

> `optional` **webdavHostname**: `string`

Defined in: [packages/b2c-tooling-sdk/src/instance/index.ts:92](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/instance/index.ts#L92)

Separate hostname for WebDAV (if different from main hostname)