Sign in

v3

latestOpenAPI 3.0.12026-07-314655871.8 MB
Service:_OpenSearch

Restore a snapshot from custom repository

post/project/{project}/service/{service_name}/opensearch/_snapshot/{repository_name}/{snapshot_name}/_restore

Path parameters

projectstring required

Project name

service_namestring required

Service name

repository_namestring required

Repository name

snapshot_namestring required

Snapshot name

Request body

ignore_index_settingsstring

Comma-delimited list of index settings to ignore

ignore_unavailableboolean

Ignore indices that are missing or closed

include_aliasesboolean

Include aliases

include_global_stateboolean

Restore global state

index_settingsstring

Comma-delimited list of index settings to override.

indicesstring required

Comma-separated list of index patterns to restore

partialboolean

Allows to restore snapshot of indices with unavailable shards

rename_alias_patternstring

Rename pattern for aliases

rename_alias_replacementstring

Rename replacement for aliases

rename_patternstring

Rename pattern for indices

rename_replacementstring

Rename replacement for indices

Response

Response

acceptedboolean required

Snapshot creation accepted

messagestring

Printable result of the request