Skip to main content

Management API

This page is a high-level map of YedMQ management endpoints. For request and response schemas, use the generated Management API Reference.

System and plugin endpoints​

  • GET /api/v1/system_info
  • GET /api/v1/plugins
  • POST /api/v1/plugins/rescan
  • GET /api/v1/plugins/{plugin_name}
  • POST /api/v1/plugins/{plugin_name}/start
  • POST /api/v1/plugins/{plugin_name}/stop
  • POST /api/v1/plugins/{plugin_name}/restart
  • GET /api/v1/plugins/{plugin_name}/logs

Plugin management notes​

  • POST /api/v1/plugins/rescan refreshes discovered manifests from disk only. It does not change plugin process state.
  • POST /api/v1/plugins/{plugin_name}/restart is the explicit way to apply an updated plugin.toml.
  • GET /api/v1/plugins supports scope and state filters in addition to offset and limit.
  • GET /api/v1/plugins/{plugin_name}/logs returns the in-memory plugin log buffer and supports tail for recent lines.

Tenant-scoped endpoints​

  • GET /api/v1/{tenant_id}/clients
  • POST /api/v1/{tenant_id}/clients/{client_id}/kickoff
  • GET /api/v1/{tenant_id}/topics
  • GET /api/v1/{tenant_id}/messages/retained
  • DELETE /api/v1/{tenant_id}/messages/retained/{topic}
  • POST /api/v1/{tenant_id}/messages

Cluster endpoints​

  • GET /api/v1/cluster/metrics
  • GET /api/v1/cluster/ready
  • POST /api/v1/cluster/init
  • POST /api/v1/cluster/learners
  • POST /api/v1/cluster/nodes
  • POST /api/v1/cluster/topic/learners
  • POST /api/v1/cluster/session_actor_map/learners
  • POST /api/v1/cluster/session_state/learners
  • POST /api/v1/cluster/membership
  • POST /api/v1/cluster/topic/membership
  • POST /api/v1/cluster/session_actor_map/membership
  • POST /api/v1/cluster/session_state/membership
  • POST /api/v1/cluster/raft/topic/init
  • POST /api/v1/cluster/raft/session_actor_map/init
  • POST /api/v1/cluster/raft/session_state/init

Cluster operation notes​

  • GET /api/v1/cluster/ready returns a structured readiness report and is the best endpoint for health checks or orchestration gates.
  • POST /api/v1/cluster/nodes is the high-level node-add flow. It coordinates learner addition and membership changes across all three raft groups.
  • The per-raft .../learners endpoints are lower-level controls intended for staged rollout, recovery, or manual repair workflows.

Reference workflow​

  1. Use the overview page to understand authentication and API grouping.
  2. Use the generated OpenAPI reference for exact payloads.
  3. Keep tenant IDs explicit in automation scripts to avoid cross-tenant mistakes.