Skip to main content
URL: http://<db.host>:<db.port>/show/backup
Shows information about one or more backups accessible via the data source specified by input parameter datasource_name.

Input Parameter Description

backup_name
string
Name of the backup. An empty string or '' will show all existing backups. Any text followed by a '' will show backups whose name starts with that text.The default value is ”.
datasource_name
string
Data source 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
‘show_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 /show/backup endpoint:Empty string in case of an error.