File tree Expand file tree Collapse file tree 3 files changed +17
-9
lines changed Expand file tree Collapse file tree 3 files changed +17
-9
lines changed Original file line number Diff line number Diff line change @@ -9,8 +9,8 @@ content: |
9
9
Get One (Cluster) </reference/api/snapshots/get-one-snapshot-for-one-cluster>
10
10
Change Expiry </reference/api/snapshots/change-expiry-for-one-snapshot>
11
11
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>
12
13
Get All (Config Server) </reference/api/snapshots/get-all-snapshots-for-config-server>
13
14
Get One (Config Server) </reference/api/snapshots/get-one-snapshot-for-config-server>
14
15
15
-
16
16
...
Original file line number Diff line number Diff line change @@ -55,6 +55,10 @@ The following lists the endpoints available for snapshots.
55
55
:gold:`IMPORTANT:` To delete a snapshot, you must issue the
56
56
request from an IP address on your user account's
57
57
: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.
58
62
59
63
.. important:: Deprecated when using MongoDB 3.4
60
64
Original file line number Diff line number Diff line change 1
- ==========================
2
- Take an On-Demand Snapshot
3
- ==========================
1
+ ============================
2
+ Create an On-Demand Snapshot
3
+ ============================
4
4
5
5
.. default-domain:: mongodb
6
6
@@ -51,17 +51,21 @@ Request Path Parameters
51
51
Request Query Parameters
52
52
~~~~~~~~~~~~~~~~~~~~~~~~
53
53
54
- The following query parameters are optional:
55
-
56
54
.. list-table::
57
55
:widths: 20 14 11 45 10
58
56
:header-rows: 1
59
57
:stub-columns: 1
60
58
59
+ * - Name
60
+ - Type
61
+ - Necessity
62
+ - Description
63
+ - Example
64
+
61
65
* - retentionDays
62
66
- number
63
67
- Required
64
- - Integer that indicates the number of days the the on-demand
68
+ - Integer that indicates the number of days the on-demand
65
69
snapshot will be retained. Must be greater than 0.
66
70
- ``15``
67
71
@@ -102,14 +106,14 @@ Example Response
102
106
----------------
103
107
104
108
Response Header
105
- +++++++++++++++
109
+ ~~~~~~~~~~~~~~~~
106
110
107
111
.. include:: /includes/api/api-headers/401.rst
108
112
109
113
.. include:: /includes/api/api-headers/200.rst
110
114
111
115
Response Body
112
- +++++++++++++
116
+ ~~~~~~~~~~~~~~~~
113
117
114
118
.. code-block:: json
115
119
You can’t perform that action at this time.
0 commit comments