mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-03-09 14:34:43 +00:00
96a06685cf
* [DOCS] Adding get snapshot API docs (#59098) * Adding page for get snapshot API. * Adding values for state and cleaning up some other formatting. * Adding missing forward slash to GET request. * Updating values for start_time and end_time in TESTRESPONSE. * Swap "return" for "retrieve" * Swap "return" for "retrieve" 2 * Change .snapshot to .response * Adding response parameters and incorporating edits from review. * Update response example to include repository info * Change dash to underscore * Add data type for snapshot in response * Incorporating review comments and adding missing response definitions. * Minor rewording in description. * Removing multi-snapshot support for 7.x. * Changing end_time value from build error. * Removing .response from snippet testing.
39 lines
1.2 KiB
Plaintext
39 lines
1.2 KiB
Plaintext
[[snapshot-restore-apis]]
|
|
== Snapshot and restore APIs
|
|
|
|
You can use the following APIs to set up snapshot repositories, manage snapshot
|
|
backups, and restore snapshots to a running cluster.
|
|
|
|
For more information, see <<snapshot-restore>>.
|
|
|
|
[NOTE]
|
|
====
|
|
We are working on including more snapshot and restore APIs in this section. Some
|
|
content may not be included yet.
|
|
====
|
|
|
|
[discrete]
|
|
[[snapshot-restore-repo-apis]]
|
|
=== Snapshot repository management APIs
|
|
* <<put-snapshot-repo-api,Put snapshot repository>>
|
|
* <<verify-snapshot-repo-api,Verify snapshot repository>>
|
|
* <<get-snapshot-repo-api,Get snapshot repository>>
|
|
* <<delete-snapshot-repo-api,Delete snapshot repository>>
|
|
* <<clean-up-snapshot-repo-api,Clean up snapshot repository>>
|
|
|
|
[discrete]
|
|
[[snapshot-management-apis]]
|
|
=== Snapshot management APIs
|
|
* <<create-snapshot-api,Create snapshot>>
|
|
* <<get-snapshot-api,Get snapshot>>
|
|
* <<delete-snapshot-api,Delete snapshot>>
|
|
|
|
include::put-repo-api.asciidoc[]
|
|
include::verify-repo-api.asciidoc[]
|
|
include::get-repo-api.asciidoc[]
|
|
include::delete-repo-api.asciidoc[]
|
|
include::clean-up-repo-api.asciidoc[]
|
|
include::create-snapshot-api.asciidoc[]
|
|
include::get-snapshot-api.asciidoc[]
|
|
include::delete-snapshot-api.asciidoc[]
|