1
0
Fork 0
arangodb/Documentation/DocuBlocks/Rest/JSF_put_api_replication_app...

1.4 KiB

//////////////////////////////////////////////////////////////////////////////// /// @startDocuBlock JSF_put_api_replication_applier_stop /// @brief stop the replication /// /// @RESTHEADER{PUT /_api/replication/applier-stop, Stop replication applier} /// /// @RESTDESCRIPTION /// Stops the replication applier. This will return immediately if the /// replication applier is not running. /// /// @RESTRETURNCODES /// /// @RESTRETURNCODE{200} /// is returned if the request was executed successfully. /// /// @RESTRETURNCODE{405} /// is returned when an invalid HTTP method is used. /// /// @RESTRETURNCODE{500} /// is returned if an error occurred while assembling the response. /// /// @EXAMPLES /// /// @EXAMPLE_ARANGOSH_RUN{RestReplicationApplierStop} /// var re = require("@arangodb/replication"); /// re.applier.shutdown(); /// re.applier.properties({ /// endpoint: "tcp://127.0.0.1:8529", /// username: "replicationApplier", /// password: "applier1234@foxx", /// autoStart: false, /// adaptivePolling: true /// }); /// /// re.applier.start(); /// var url = "/_api/replication/applier-stop"; /// var response = logCurlRequest('PUT', url, ""); /// re.applier.shutdown(); /// /// assert(response.code === 200); /// logJsonResponse(response); /// @END_EXAMPLE_ARANGOSH_RUN /// @endDocuBlock ////////////////////////////////////////////////////////////////////////////////