> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hyphaedb.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Readiness probe

> Unauthenticated readiness probe. Returns `200 ready` while serving; `503 draining` once a graceful shutdown has begun, so a load balancer removes the pod from rotation before the drain (deployment-operations.md §7.4). Liveness (`/healthz`) stays 200 throughout.



## OpenAPI

````yaml /api-reference/openapi.json get /readyz
openapi: 3.0.3
info:
  title: HyphaeDB REST API
  version: 1.0.0
  description: >-
    The unary REST surface over the HyphaeDB internal service facade. JSON over
    HTTP/1.1; every endpoint is a thin translator onto the same facade that gRPC
    and MCP speak. `recall` and `query` return fully hydrated nodes in rank
    order (nearest-first); no similarity score rides the wire — the array order
    conveys the rank.


    All endpoints except `GET /healthz` require an API key supplied in the
    `x-hyphae-key` header. Errors use a uniform envelope: `{ "error": { "code":
    string, "message": string } }`.


    This document covers the unary REST endpoints only. The WebSocket gossip
    stream (`GET /v1/inbox`) and the MCP-over-HTTP endpoint (`POST /mcp`) are
    separate surfaces not described here, and `GET /openapi.json` serves this
    document itself.
servers:
  - url: http://localhost:8080
    description: Local HyphaeDB server
security:
  - ApiKeyAuth: []
tags:
  - name: Memory
    description: Store and retrieve knowledge cells.
  - name: Sessions
    description: Open and close working sessions.
  - name: Beacons
    description: Standing interest beacons for gossip routing.
  - name: Inbox
    description: 'The gossip inbox: the unary work-cycle drain for non-resident agents.'
  - name: Scenes
    description: Scene listing, lookup, and consolidation.
  - name: Health
    description: Liveness probe.
paths:
  /readyz:
    get:
      tags:
        - Health
      summary: Readiness probe
      description: >-
        Unauthenticated readiness probe. Returns `200 ready` while serving; `503
        draining` once a graceful shutdown has begun, so a load balancer removes
        the pod from rotation before the drain (deployment-operations.md §7.4).
        Liveness (`/healthz`) stays 200 throughout.
      operationId: readyz
      responses:
        '200':
          description: The server is ready for traffic.
          content:
            text/plain:
              schema:
                type: string
                example: ready
        '503':
          description: >-
            The server is draining (graceful shutdown in progress) and not ready
            for new traffic.
          content:
            text/plain:
              schema:
                type: string
                example: draining
      security: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-hyphae-key
      description: >-
        The API key issued for the calling agent. Required on every endpoint
        except `GET /healthz`.

````