Home / Repstance User Guide / INTERACTING WITH REPSTANCE SERVER / REST API

REST API

This is the detailed command structure for communicating with Repstance Services, it sends an HTTP/HTTPS request in the “JSON Format” to the services and adheres to the established protocols for the JSON format. List of the available Repstance commands and their specification is provided in chapters: DATABASE CONFIGURATION COMMANDS, PROCESS CONFIGURATION COMMANDS, PROCESS CONTROL COMMANDS.

The following example demonstrates how to use REST API to call “status” command from a remote computer, where token is the HTTPS authorisation token (see Configure repcli for Remote Access):

$ curl --insecure \
  --header "Content-Type: application/json" \
  --header "X-Token: token" \
  --request POST \
  --data '{"command": "status"}' \
  https://hostname:8797/control/process

The --insecure option is required only while the Self-signed Certificate that is supplied with the product is used.

On the Repstance Server itself the command can also be sent to the local HTTP port:

$ curl --header "Content-Type: application/json" \
  --request POST \
  --data '{"command": "status"}' \
  http://localhost:8796/control/process

Web User Interface (Web UI)

CONFIGURE REPLICATION WITH REPSTANCE