Status

Status related operations

Fetches the status of the Replication Server.

get

http://127.0.0.1:64001http://127.0.0.1:32004

/status

Authorizations

rs_auth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Status was fetched successfully

application/json

connected_clientsinteger · uint64Required

Current number of clients served (excluding PersistenceClients and Simulators).

memory_limitinteger · int64Required

Target memory limit for the process.

memory_usedinteger · int64Required

Current memory usage of the process (can be higher than MemoryLimit).

500

Internal Replication Server error

application/json

get

/status

HTTPcURLJavaScriptPython

GET /status HTTP/1.1
Host: 127.0.0.1:64001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "connected_clients": 1,
  "memory_limit": 1,
  "memory_used": 1
}

Health check endpoint for the Replication Server.

get

http://127.0.0.1:64001http://127.0.0.1:32004

/health

Authorizations

rs_basic

AuthorizationstringRequired

Responses

200

Health check was successful

text/html

stringOptionalExample: OK

500

Server is unhealthy

application/json

get

/health

HTTPcURLJavaScriptPython

GET /health HTTP/1.1
Host: 127.0.0.1:64001
Authorization: Basic username:password
Accept: */*

OK