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

# AlterBackupRequest

> AlterBackupRequest — Kinetica JavaScript API

interface AlterBackupRequest \{\
&#x20;[action](#action): string;\
&#x20;[backup\_name](#backup_name): string;\
&#x20;[datasink\_name](#datasink_name): string;\
&#x20;[options](#options)?: Record\<string, string>;\
&#x20;[value](#value): string;\
}

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

##### Index

### Properties

[action](#action) [backup\_name](#backup_name) [datasink\_name](#datasink_name) [options?](#options) [value](#value)&#x20;

## Properties

### action

action: string

Operation to be applied.

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

### backup\_name

backup\_name: string

Name of the backup to be altered.

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

### datasink\_name

datasink\_name: string

Data sink through which the backup is accessible.

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

### `Optional`options

options?: Record\<string, string>

Optional parameters.

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

### value

value: string

Value of the modification, depending on `action`.

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


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