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

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

# Interface: SiteArchiveImportOptions

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:28](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts#L28)

Options for site archive import.

## Properties

### keepArchive?

> `optional` **keepArchive**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:30](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts#L30)

Keep archive on instance after import (default: false)

***

### maxBytes?

> `optional` **maxBytes**: `number`

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:54](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts#L54)

Optional soft size ceiling (in bytes) for the assembled archive. When set
along with [SiteArchiveImportOptions.onOversize](#onoversize) and the archive
exceeds it, the callback is invoked before upload — the import still
proceeds. The SDK itself does not warn or block; the consumer decides how
to react. Use [siteArchiveImportSplit](../functions/siteArchiveImportSplit.md) to split oversized imports.

***

### onOversize()?

> `optional` **onOversize**: (`info`) => `void`

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:60](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts#L60)

Called before upload when the assembled archive exceeds `maxBytes`. Lets
the consumer (e.g. the CLI) surface its own guidance. Receives the archive
size and the configured ceiling.

#### Parameters

##### info

###### bytes

`number`

###### maxBytes

`number`

#### Returns

`void`

***

### paths?

> `optional` **paths**: `string`[]

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:46](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts#L46)

Optional list of paths or glob patterns to include in the archive when
importing from a directory. Each entry may be:
- An absolute path under the root directory
- A path relative to the root directory
- A glob pattern (relative to the root) — magic chars `* ? [ ] { }`

When omitted, the entire root directory is archived (current behavior).
Entries that resolve outside the root directory throw an error.
Ignored when target is a zip file, Buffer, or remote filename.

***

### wait?

> `optional` **wait**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:32](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts#L32)

Whether to wait for job completion (default: true)

***

### waitOptions?

> `optional` **waitOptions**: [`WaitForJobOptions`](WaitForJobOptions.md)

Defined in: [packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts:34](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/operations/jobs/site-archive.ts#L34)

Wait options for job completion