/verify/backup

URL: http://<db.host>:<db.port>/verify/backup

Inspects the requested database backup(s) for conformity at the remote file store accessible via the data source specified by input parameter datasource_name. By default all snapshots are inspected unless the option backup_id is used to target a specific instance. Returns backup verification results.

Input Parameter Description

Name

Type

Description

backup_name

string

Name of the backup. An empty string or '*' will check all existing backups. Any text followed by a '*' will inspect 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 ( {} ).

Supported Parameters (keys)

Parameter Description

backup_id

ID of the snapshot to verify. Set to '-1' to verify only the most recent snapshot in the backup. Leave empty to verify all snapshots.

The default value is -1.

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:

Name

Type

Description

status

String

'OK' or 'ERROR'

message

String

Empty if success or an error message

data_type

String

'verify_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 /verify/backup endpoint:

Name	Type	Description
backup_name	string	Value of input parameter backup_name.
backup_names	array of strings	Backup name(s).
backup_ids	array of arrays of longs	IDs of individual snapshots per backup name.
errors	array of arrays of strings	Any errors detected from the inspection of each backup.
info	map of string to strings	Additional information.

Empty string in case of an error.