Skip to main content
URL: http://<db.host>:<db.port>/create/backup
Creates a database backup, containing a snapshot of existing objects, at the remote file store accessible via the data sink specified by input parameter datasink_name.

​
Input Parameter Description

​
backup_name
string
Name for this backup. If the backup already exists, only an incremental or differential backup can be made, unless recreate is set to true.
​
backup_type
string
Type of snapshot to create.
  • differential: Snapshot of changes in the database objects and data since the last full snapshot.
  • full: Snapshot of the given database objects and data.
  • incremental: Snapshot of changes in the database objects and data since the last snapshot of any kind.
​
backup_objects_map
map of string to strings
Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot.The default value is an empty map ( {} ).
​
datasink_name
string
Data sink through which the backup will be stored.
​
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
‘create_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 /create/backup endpoint:Empty string in case of an error.