- API Reference
- Box API
- 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.
GET
/health/readyAuthentication
Always public; no login or token is ever checked.
Responses
Readiness state.
statusstringoptional
One of
ok, degradedcore_readybooleanoptional
The readiness check raised an error.
statusstringoptional
errorstringoptional