It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
RestoreSnapshotConfiguration
editRestoreSnapshotConfiguration
editRestores a snapshot from a local or remote repository.
Properties
edit-
repository_config(RestoreSnapshotRepoConfiguration) - Raw remote snapshot restore settings. Do not send this if you are sending source_cluster_id
-
repository_name(string) - If specified, contains the name of the snapshot repository - else will default to the Elastic Cloud system repo ('found-snapshots')
-
restore_payload(RestoreSnapshotApiConfiguration) - The configuration for the restore command, such as which indices you want to restore.
-
snapshot_name(string, required) - The name of the snapshot to restore. Use '__latest_success__' to get the most recent snapshot from the specified repository
-
source_cluster_id(string) - If specified, contains the name of the source cluster id. Do not send this if you are sending repository_config
-
strategy(string; allowed values: [partial,full]) - The restore strategy to use. Defaults to a full restore. Partial restore will attempt to restore unavailable indices only
Example
edit{
"repository_config" : {
"raw_settings" : {}
},
"repository_name" : "string",
"restore_payload" : {
"indices" : [
"string"
],
"raw_settings" : {}
},
"snapshot_name" : "string",
"source_cluster_id" : "string",
"strategy" : "string"
}