API Reference
Dashboard
  1. API Reference
  2. Box API
  3. Health

Check that the box finished starting and can serve proxies

Use this as a readiness probe after a restart or update. core_ready turns true once the controller core finished starting; until then status is degraded. HTTP 500 with status: error means the check itself failed.

  • Read only
  • No authentication
  • Public API · since v20.8.0
  • Hub: needs owner approval
  • healthReady
GET/health/ready

Authentication

Always public; no login or token is ever checked.

Responses

Readiness state.

statusstringoptional
One of ok, degraded
core_readybooleanoptional
Verified against XProxy v21.3.2 on Nov 17, 2026