DOCSP-32282 API Security

source/includes/fact-api-endpoint.rst

@@ -0,0 +1,8 @@
+
+
+``mongosync`` does not protect the |endpoint| endpoint.  However, by default 
+the API binds to localhost only and does not accept calls from other sources.
+Additionally, the |endpoint| call does not expose connection credentials 
+or user data.
+
+

source/reference/api/commit.txt

@@ -155,7 +155,6 @@ State
 ~~~~~
 
 If the ``commit`` request is successful, ``mongosync`` enters the
-``COMMITTING`` state, then automatically transitions to the
 ``COMMITTED`` state. Once ``mongosync`` enters the ``COMMITTED`` state,
 continuous sync between the clusters stops. 
 
@@ -164,4 +163,11 @@ Data Verification
 
 .. include:: /includes/fact-verification
 
+Endpoint Protection
+~~~~~~~~~~~~~~~~~~~
+
+.. |endpoint| replace:: ``commit``
+.. include:: /includes/fact-api-endpoint
+
+
 

source/reference/api/pause.txt

@@ -77,3 +77,12 @@ Behavior
   increase the size of the replica set :term:`oplog` in the source
   cluster. To learn more, see :ref:`Frequently Asked Questions
   <c2c-faq-increase-oplog>`. 
+
+Endpoint Protection
+~~~~~~~~~~~~~~~~~~~
+
+.. |endpoint| replace:: ``pause``
+.. include:: /includes/fact-api-endpoint
+
+
+

source/reference/api/progress.txt

@@ -59,6 +59,13 @@ Behavior
 - The endpoint does not auto-refresh. To get updated status, call the
   ``progress`` endpoint again.
 
+Endpoint Protection
+~~~~~~~~~~~~~~~~~~~
+
+.. |endpoint| replace:: ``progress``
+.. include:: /includes/fact-api-endpoint
+
+
 Example
 -------
 

source/reference/api/resume.txt

@@ -73,3 +73,11 @@ Behavior
 
 If the ``resume`` request is successful, ``mongosync`` enters the
 ``RUNNING`` state.
+
+Endpoint Protection
+~~~~~~~~~~~~~~~~~~~
+
+.. |endpoint| replace:: ``resume``
+.. include:: /includes/fact-api-endpoint
+
+

source/reference/api/reverse.txt

@@ -141,3 +141,10 @@ To view the mapping direction for the synchronization of the source and
 destination clusters, use the :ref:`progress <c2c-api-progress>`
 endpoint and check the ``directionMapping`` object.
 
+Endpoint Protection
+~~~~~~~~~~~~~~~~~~~
+
+.. |endpoint| replace:: ``reverse``
+.. include:: /includes/fact-api-endpoint
+
+

source/reference/api/start.txt

@@ -474,4 +474,11 @@ Indexes that are always built include:
   sharded collection, which are removed after commit. When ``buildIndexes`` is
   set to ``never``, ``mongosync`` retains this index after commit.
 
-
+
+Endpoint Protection
+~~~~~~~~~~~~~~~~~~~
+
+.. |endpoint| replace:: ``start``
+.. include:: /includes/fact-api-endpoint
+
+