For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
CloudGitHub
  • API Reference
      • GETCollect telemetry data
      • GETRetrieve instance details
      • GETCollect Prometheus metrics data
      • GETCheck write protection
      • POSTSet write protection
      • GETKubernetes health check
      • GETKubernetes liveness probe
      • GETKubernetes readiness probe
LogoLogo
CloudGitHub
API ReferenceService

Kubernetes liveness probe

GET
/livez
GET
/livez
$curl http://localhost:6333/livez \
>     -H "api-key: <apiKey>"
200Retrieved
1"healthz check passed"
Monitors the container responsiveness and alerts in case of failure.
Was this page helpful?
Previous

Kubernetes readiness probe

Next
Built with

Authentication

api-keystring
API Key authentication via header

Response

This endpoint returns an object.