> ## 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.

# create_backup

### create\_backup

<ul>
  <li>
    create\_backup(\
    &#x20;backup\_name: string,\
    &#x20;backup\_type: string,\
    &#x20;backup\_objects\_map: Record\<string, string> | undefined,\
    &#x20;datasink\_name: string,\
    &#x20;options?: Record\<string, string>,\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md),\
    ): Promise\<[CreateBackupResponse](https://docs.kinetica.com/content/api/typescript/interfaces/CreateBackupResponse.md)>

    Creates a database backup, containing a snapshot of existing objects, at the remote file store accessible via the data sink specified by `datasink_name`.

    #### Parameters

    <ul>
      <li>
        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.
      </li>

      <li>
        backup\_type: string

        Type of snapshot to create.
      </li>

      <li>
        backup\_objects\_map: Record\<string, string> | undefined

        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.
      </li>

      <li>
        datasink\_name: string

        Data sink through which the backup will be stored.
      </li>

      <li>
        `Optional`options: Record\<string, string>

        Optional parameters.
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[CreateBackupResponse](https://docs.kinetica.com/content/api/typescript/interfaces/CreateBackupResponse.md)>

    Promise\<Types.CreateBackupResponse> - Promise resolving to the response

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

### create\_backup\_request

<ul>
  <li>
    create\_backup\_request(\
    &#x20;request: [CreateBackupRequest](https://docs.kinetica.com/content/api/typescript/interfaces/CreateBackupRequest.md),\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md),\
    ): Promise\<[CreateBackupResponse](https://docs.kinetica.com/content/api/typescript/interfaces/CreateBackupResponse.md)>

    Creates a database backup, containing a snapshot of existing objects, at the remote file store accessible via the data sink specified by `datasink_name`.

    #### Parameters

    <ul>
      <li>
        request: [CreateBackupRequest](https://docs.kinetica.com/content/api/typescript/interfaces/CreateBackupRequest.md)

        Request object containing the parameters for the operation
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[CreateBackupResponse](https://docs.kinetica.com/content/api/typescript/interfaces/CreateBackupResponse.md)>

    Promise\<Types.CreateBackupResponse> - Promise resolving to the response

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


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