OpenSearch/docs/reference/snapshot-restore/apis/snapshot-restore-apis.asciidoc
Adam Locke 305b46c7cd
[DOCS] Adding get snapshot status API docs (#59355) (#59670)
* Adding get snapshot status API docs.

* Adding more fields and a link to the new page.

* Adding missing spaces in TESTRESPONSES

* Adding more parameters and making some edits.

* Marking snapshot as optional

* Marking repository as optional

* Add data type for stats

* Add data type for shard_stats

* Incorporating review feedback.

* Lots of review feedback incorporated.

* Fixing tests to unbreak CI builds.

* Changing indices to index.
2020-07-16 11:21:17 -04:00

41 lines
1.3 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>>
* <<get-snapshot-status-api,Get snapshot status>>
* <<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::get-snapshot-status-api.asciidoc[]
include::delete-snapshot-api.asciidoc[]