> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# CreateBackupRequest

> CreateBackupRequest — Kinetica JavaScript API

interface CreateBackupRequest \{\
&#x20;[backup\_name](#backup_name): string;\
&#x20;[backup\_objects\_map](#backup_objects_map)?: Record\<string, string>;\
&#x20;[backup\_type](#backup_type): string;\
&#x20;[datasink\_name](#datasink_name): string;\
&#x20;[options](#options)?: Record\<string, string>;\
}

<ul>
  <li>Defined in [src/types.ts:1403](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L1403)</li>
</ul>

##### Index

### Properties

[backup\_name](#backup_name) [backup\_objects\_map?](#backup_objects_map) [backup\_type](#backup_type) [datasink\_name](#datasink_name) [options?](#options)&#x20;

## Properties

### backup\_name

backup\_name: string

Name for this backup. If the backup already exists, only an incremental or differential backup can be made, unless recreate is set to true.

<ul>
  <li>Defined in [src/types.ts:1408](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L1408)</li>
</ul>

### `Optional`backup\_objects\_map

backup\_objects\_map?: Record\<string, string>

Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot.

<ul>
  <li>Defined in [src/types.ts:1416](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L1416)</li>
</ul>

### backup\_type

backup\_type: string

Type of snapshot to create.

<ul>
  <li>Defined in [src/types.ts:1410](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L1410)</li>
</ul>

### datasink\_name

datasink\_name: string

Data sink through which the backup will be stored.

<ul>
  <li>Defined in [src/types.ts:1418](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L1418)</li>
</ul>

### `Optional`options

options?: Record\<string, string>

Optional parameters.

<ul>
  <li>Defined in [src/types.ts:1420](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L1420)</li>
</ul>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.