Deletes one or more existing database
backups and contained
snapshots, accessible via the data sink
specified by input parameter datasink_name.
Input Parameter Description
string
Name of the backup to be deleted. An empty string or '' will delete all existing backups. Any text followed by a '' will delete backups whose name starts with that text. When deleting multiple backups, delete_all_backups must be set to true.
string
Data sink through which the backup is accessible.
map of string to strings
Optional parameters.The default value is an empty map ( {} ).
Show options
Whether or not to perform a dry run of a backup deletion.The default value is false.The supported values are:
true
false
Allow multiple backups to be deleted if true and multiple backup names are found matching input parameter backup_name.The default value is false.The supported values are:
true
false
Whether or not to suppress the error if the specified backup does not exist.The default value is false.The supported values are:
true
false
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:
String
‘OK’ or ‘ERROR’
String
Empty if success or an error message
String
‘drop_backup_response’ or ‘none’ in case of an error
String
Empty string
JSON or String
This embedded JSON represents the result of the /drop/backup endpoint:
Show data_str
string
Value of input parameter backup_name.
array of strings
Names of backups that were deleted.
map of string to strings
Additional information.
Empty string in case of an error.
Assistant
Responses are generated using AI and may contain mistakes.