Replication — MDDB API

Leader-follower replication status and monitoring

Replication status #

GET /v1/replication/status

Returns the replication status of this node, including role, LSN, binlog stats, and connected followers (leader only).

Available for all roles: standalone, leader, and follower.

Replication Architecture #

MDDB uses a pull-based, single-leader replication model. Wait for the healthy flag to determine if the node is fully synced.

graph LR
    L[Leader] -->|Binlog Stream| F1[Follower 1]
    L -->|Binlog Stream| F2[Follower 2]

See Replication documentation for full setup instructions and monitoring.

Authorization: BearerAuth or APIKeyAuth or none

Responses #

Status	Description	Body
200	Replication status	ReplicationStatusResponse (application/json)
401	Auth is on (MDDB_AUTH_ENABLED=true) and the request carries no credentials, an invalid or expired JWT, or an unknown API key.	ErrorResponse (application/json)
429	The client is over the API rate limit (MDDB_RATE_LIMIT_ENABLED=true, MDDB_RATE_LIMIT_REQUESTS per MDDB_RATE_LIMIT_WINDOW seconds). A call that embeds can also be refused by the collection's daily embedding budget, with a QuotaExceeded body.	RateLimitError (application/json)

401 example (application/json)

{
  "error": "missing authentication"
}