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

# alter_backup

### alter\_backup

<ul>
  <li>
    alter\_backup(\
    &#x20;backup\_name: string,\
    &#x20;action: string,\
    &#x20;value: string,\
    &#x20;datasink\_name: string,\
    &#x20;options?: Record\<string, string>,\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/javascript/types/GPUdbCallback.md),\
    ): Promise\<[AlterBackupResponse](https://docs.kinetica.com/content/api/javascript/interfaces/AlterBackupResponse.md)>

    Alters an existing database backup, accessible via the data sink specified by `datasink_name`.

    #### Parameters

    <ul>
      <li>
        backup\_name: string

        Name of the backup to be altered.
      </li>

      <li>
        action: string

        Operation to be applied.
      </li>

      <li>
        value: string

        Value of the modification, depending on `action`.
      </li>

      <li>
        datasink\_name: string

        Data sink through which the backup is accessible.
      </li>

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

        Optional parameters.
      </li>

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

        Optional callback function
      </li>
    </ul>

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

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

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

### alter\_backup\_request

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

    Alters an existing database backup, accessible via the data sink specified by `datasink_name`.

    #### Parameters

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

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

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

        Optional callback function
      </li>
    </ul>

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

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

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


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