federation.health

Check health of all registered federation services.

Returns the health status of every service registered in the federation adapter registry. Useful for monitoring and debugging connectivity.

Endpoint

/api/federation/health

Parameters

None.

Response

interface FederationHealth {
  services: FederationServiceHealth[]
  summary: {
    total: number
    healthy: number
    degraded: number
    down: number
  }
}

interface FederationServiceHealth {
  name: string
  status: 'healthy' | 'degraded' | 'down'
  latency_ms?: number
  error?: string
  last_checked: string
}

Examples

cURL:

curl https://api.blueforge.studio/api/federation/health \
  -H "Authorization: Bearer $BF_API_KEY"

CLI:

forge federation list

Pitfalls

• Network-dependent — health checks may fail if the service adapter cannot reach its target. This does not affect other federation services.
• Caching — results are cached for 30 seconds. Use the

  --no-cache

  flag for real-time status.

See also

{auto-injected}

Tested against

{auto-injected}