Cluster Monitor APIs

Cluster Monitor APIs

APIs for monitoring Security Services Platform cluster, features, and services.

Endpoint Guide:

  • /cluster/monitor/feature/health - Hierarchical health: Features -> Services -> Components
  • /cluster/monitor/platform/status - Complete cluster state: health, config, form factor, versions
  • /cluster/monitor/services/status - Service metrics: health and resource utilization per category

Workflow: Start with /platform/status for overall health, then drill into /feature/health for feature issues or /services/status for resource issues.

Common Concepts:

  • Health: UP, PARTIALLY_UP, DOWN
  • Data refresh: Health cached (60s), metrics real-time

Operations
GET
Get Feature Health
Retrieve hierarchical feature and component health status
GET
Get Platform Status
Get comprehensive cluster status and deployment configuration
GET
Get Services Status
Monitor individual platform service health and resource utilization