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 readiness probe

GET
/readyz
GET
/readyz
$curl http://localhost:6333/readyz \
>     -H "api-key: <apiKey>"
200Retrieved
1"healthz check passed"
Checks the instance to see when it can start accepting traffic.
Was this page helpful?
Previous

Report issues

Next
Built with

Authentication

api-keystring
API Key authentication via header

Response

This endpoint returns an object.