Skip to content

Micro-Services

The Micro-Services page allows Super Users to view, register, and manage the micro-services that compose the EZY Portal platform. Each micro-service is an independently deployable backend service that exposes functionality through the portal’s API gateway.

RoleAccess Level
Tenant AdminNo access
Account AdminNo access
Super UserFull access

Visible to Super Users only.

  • Service Registry — View all registered micro-services with their name, version, health status, and base URL.
  • Service Registration — Register a new micro-service by providing its name, API base URL, and authentication configuration.
  • Health Status — Real-time health indicator for each service (Healthy, Degraded, Unreachable) based on periodic heartbeat checks.
  • Service Deregistration — Remove a micro-service from the registry when it is decommissioned.
  • Version Management — Track the deployed version of each service and view the change history.
  • Configuration Overrides — Set environment-level configuration overrides for individual services directly from the portal.

:::tip TODO

  • Provide a step-by-step guide for registering a new custom micro-service.
  • Document the heartbeat endpoint contract expected by the portal for health checks.
  • Add a guide on rolling back a service version via the registry. :::