URL: http://<db.host>:<db.port>/restore/backup
Restores database objects from a
backup accessible via the
data source specified by input parameter
datasource_name .
Name of the backup to restore from, which must refer to an existing backup. The default value is ”.
Map of database objects to be restored from the backup. All object types and data contained in the given schema(s) . Role(s) , role members (roles or users, recursively), and associated permissions.Table(s) and SQL view(s) . Tables with subscriptions will by default be restored in the state they were in at the time of the snapshot. See restore_subscriptions for options to override the default behavior.User(s) (internal and external) and associated permissions.Data source through which the backup will be restored.
Optional parameters. The default value is an empty map ( {} ). ID of the snapshot to restore. Leave empty to restore the most recent snapshot in the backup. The default value is ”.
Whether or not to verify checksums for backup files when restoring. The default value is false. The supported values are: create_schema_if_not_exist
Behavior to apply when the schema containing any database object to restore does not already exist. The default value is true.
true : If the schema containing any restored object does not exist, create it automatically.false : If the schema containing any restored object does not exist, return an error. Behavior to apply when restoring tables. The default value is false.
true : Restore table DDL, but do not restore data.false : Restore tables and their data. Whether or not to perform a dry run of the restoration operation. The default value is false. The supported values are: Behavior to apply when restoring datasource subscriptions on tables. The default value is resume.
resume : Resume subscriptions that were active when the backup was made.pause : Pause subscriptions that were active when the backup was made.cancel : Cancel active subscriptions. Behavior to apply when restoring table data. The default value is false.
true : Restore table data by re-ingesting it. This is the default behavior if the cluster topology differs from that of the contained backup.false : Restore the persisted data files directly. If the restore_policy is rename , use this schema for relocated existing objects instead of the default generated one. The default value is ”.
Behavior to apply when any database object to restore already exists. The default value is none.
none : If an object to be restored already exists with the same name, abort and return error.replace : If an object to be restored already exists with the same name, replace it with the backup version.rename : If an object to be restored already exists with the same name, move that existing one to the schema specified by renamed_objects_schema . This policy does not apply to non-schema objects. 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:
Empty if success or an error message
‘restore_backup_response’ or ‘none’ in case of an error
This embedded JSON represents the result of the /restore/backup endpoint: Value of input parameter backup_name .
ID of the snapshot that was restored.
Total size of data restored from backup.
Total number of files restored from backup.
Total number of records restored from backup.
Database objects that were successfully restored and their associated types.
Original and new names of database objects that were successfully restored and their associated types.
Database objects that failed to be restored and their associated types.
Empty string in case of an error. 
