Skip to main content
URL: http://<db.host>:<db.port>/alter/backup
Alters an existing database backup, accessible via the data sink specified by input parameter datasink_name.

​
Input Parameter Description

​
backup_name
string
Name of the backup to be altered.
​
action
string
Operation to be applied.
  • checksum: Calculate checksum for backed-up files.
  • ddl_only: Whether or not to only save DDL and not back up table data, when taking future snapshots; set input parameter value to ‘true’ or ‘false’ for DDL only or DDL and table data, respectively.
  • max_incremental_backups_to_keep: Maximum number of incremental snapshots to keep, when taking future snapshots; set input parameter value to the number of snapshots to keep.
  • merge: Merges all snapshots within a backup and creates a single full snapshot.
  • purge: Deletes a snapshot from a backup; set input parameter value to the snapshot ID to purge.
​
value
string
Value of the modification, depending on input parameter action.
​
datasink_name
string
Data sink through which the backup is accessible.
​
options
map of string to strings
Optional parameters.The default value is an empty map ( {} ).

​
Output Parameter Description

The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:
​
status
String
‘OK’ or ‘ERROR’
​
message
String
Empty if success or an error message
​
data_type
String
‘alter_backup_response’ or ‘none’ in case of an error
​
data
String
Empty string
​
data_str
JSON or String
This embedded JSON represents the result of the /alter/backup endpoint:Empty string in case of an error.