Skip to main content
Version: v2.0.0

Admin API Reference

Audience: operators and dashboards. Every endpoint below lives on the admin HTTP port (default 10106), served by UniAdminServer — a separate server so management traffic never competes with data traffic.


Authentication: fail-closed bearer guard

Every endpoint except /admin/health requires:

Authorization: Bearer <value of -Deventmesh.admin.token>
SituationResult
Valid bearerRequest proceeds
Missing / wrong bearer401 {"error":"unauthorized", …}
No token configured at all503 {"error":"admin_locked", …} — the admin API is fail-closed by default; set -Deventmesh.admin.token=<secret> to enable

The comparison is constant-time. /admin/health is exempt so liveness probes work unauthenticated.

Endpoints

Health & metrics

EndpointMethodReturns
/admin/healthGET{"status":"UP", …} + pending deliveries + partitions — liveness probe
/admin/metricsGETJSON counters: publishCount, publishFailed, rateLimited, eventsDispatched, ackCount, redeliveries, dlqCount, pendingDeliveries
/metricsGETPrometheus text exposition (eventmesh_publish_count, eventmesh_publish_failed_count, eventmesh_rate_limited_count, eventmesh_dispatched_count, eventmesh_ack_count, eventmesh_redeliveries_count, eventmesh_dlq_count, gauge eventmesh_pending_deliveries)

Introspection

EndpointMethodQueryReturns
/admin/subscriptionsGET?topic=Active subscriptions {subscriptionId, clientId, topic, mode}
/admin/offsetsGET?topic=Distribution offsets / lag
/admin/clientsGET?topic=Online clients + pending
/admin/dlq/browseGET?topic=&max=Dead-lettered events

Operations

EndpointMethodQueryEffect
/admin/client/rejectPOST?clientId=Evict a client
/admin/dlq/replayPOST?topic=&max=Replay dead-lettered events
/admin/ratelimitGET/POSTInspect / adjust per-topic rate limits

Connectors

EndpointMethodEffect
/admin/connectorsGET/POST/DELETEConnector definition CRUD
/admin/connector-workersGET/POSTWorker registry / heartbeats
/connector/offsetGETConnector offset state

Connector operations go through the runtime's ConnectorScheduler; a misconfigured or unauthorized connector definition is rejected before any JAR is loaded.

Where the code lives

  • eventmesh-runtime/.../admin/UniAdminServer.java — routes + token guard
  • eventmesh-runtime/.../admin/UniAdminService.java — the cluster view
  • Related guides: Observability (metrics semantics, SLOs, alerts), Deployment (runbooks).