Skip to content

Commit 41c943b

Browse files
(DOCSP-45304) adds api documentation for taking an on demand snapshot-v8.0-backport (633) (#758)
# Backport This will backport the following commits from `master` to `v8.0`: - [(DOCSP-45304) adds page to toc](10gen/docs-ops-manager#633) - [(DOCSP-45304) fixes build errors](10gen/docs-ops-manager#633) - [(DOCSP-45304) eliminating a redundant line](10gen/docs-ops-manager#633) - [(DOCSP-45304) copy feedback](10gen/docs-ops-manager#633) - [(DOCSP-45304) adds api docs for taking an on-demand snapshot](10gen/docs-ops-manager#633) - [(DOCSP-45304) re initiating build](10gen/docs-ops-manager#633) - [(DOCSP-45304) fixes build error](10gen/docs-ops-manager#633) <!--- Backport version: 9.6.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) --------- Co-authored-by: Carrie Kim <[email protected]>
1 parent f588772 commit 41c943b

File tree

3 files changed

+17
-9
lines changed

3 files changed

+17
-9
lines changed

source/includes/extracts-api-toc-snapshots.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ content: |
99
Get One (Cluster) </reference/api/snapshots/get-one-snapshot-for-one-cluster>
1010
Change Expiry </reference/api/snapshots/change-expiry-for-one-snapshot>
1111
Remove One </reference/api/snapshots/remove-one-snapshot-from-one-cluster>
12+
Create One On-Demand (Cluster) </reference/api/snapshots/take-an-on-demand-snapshot>
1213
Get All (Config Server) </reference/api/snapshots/get-all-snapshots-for-config-server>
1314
Get One (Config Server) </reference/api/snapshots/get-one-snapshot-for-config-server>
1415
15-
1616
...

source/reference/api/snapshots.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,10 @@ The following lists the endpoints available for snapshots.
5555
:gold:`IMPORTANT:` To delete a snapshot, you must issue the
5656
request from an IP address on your user account's
5757
:ref:`access list <access-list-for-api-operations>`.
58+
59+
* - POST
60+
- :doc:`/groups/{groupId}/clusters/{clusterId}/snapshots/onDemandSnapshot </reference/api/snapshots/take-an-on-demand-snapshot>`
61+
- Create one on-demand snapshot for a cluster.
5862

5963
.. important:: Deprecated when using MongoDB 3.4
6064

source/reference/api/snapshots/take-an-on-demand-snapshot.txt

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
==========================
2-
Take an On-Demand Snapshot
3-
==========================
1+
============================
2+
Create an On-Demand Snapshot
3+
============================
44

55
.. default-domain:: mongodb
66

@@ -51,17 +51,21 @@ Request Path Parameters
5151
Request Query Parameters
5252
~~~~~~~~~~~~~~~~~~~~~~~~
5353

54-
The following query parameters are optional:
55-
5654
.. list-table::
5755
:widths: 20 14 11 45 10
5856
:header-rows: 1
5957
:stub-columns: 1
6058

59+
* - Name
60+
- Type
61+
- Necessity
62+
- Description
63+
- Example
64+
6165
* - retentionDays
6266
- number
6367
- Required
64-
- Integer that indicates the number of days the the on-demand
68+
- Integer that indicates the number of days the on-demand
6569
snapshot will be retained. Must be greater than 0.
6670
- ``15``
6771

@@ -102,14 +106,14 @@ Example Response
102106
----------------
103107

104108
Response Header
105-
+++++++++++++++
109+
~~~~~~~~~~~~~~~~
106110

107111
.. include:: /includes/api/api-headers/401.rst
108112

109113
.. include:: /includes/api/api-headers/200.rst
110114

111115
Response Body
112-
+++++++++++++
116+
~~~~~~~~~~~~~~~~
113117

114118
.. code-block:: json
115119

0 commit comments

Comments
 (0)