Replicator API Specifics

The Replicator API is enabled by default but only listens to localhost connections on port 8097.

The Replicator REST API can be disabled with the tpm flag:

replicator-rest-api=false

If required, the listen port can be changed using the tpm option:

replicator-rest-api-port=8097

Exposing the API to a different network address for remote access, like an internal network, consists in changing the "listen address" of the API server. For example, granting access to local 192.168.1.* network would translate to the tpm flag:

replicator-rest-api-listen-address=192.168.1.0

warning

Note that exposing the API to a public network can introduce a security breach like brute-force or DDoS attacks exposure.

The replicator API has two sets of API calls, based either on the whole replicator or on a service of the replicator. A few examples follow and the full Replicator Developer Documentation can be viewed here: Replicator Developer Documentation (v8)