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

# Check node health

> Check for node health. If `ready` is true, also check
if this node is fully operational and ready to accept SQL connections.
Otherwise, this endpoint always returns a successful response (if the API
server is up).



## OpenAPI

````yaml /openapi/cluster-api-v2.json get /health/
openapi: 3.0.0
info:
  description: >-
    REST API for querying information about CockroachDB cluster health, nodes,
    ranges,

    sessions, and other meta information. For additional details, see
    cockroachlabs.com/docs/stable/cluster-api.
  title: CockroachDB v2 API
  license:
    name: Business Source License
  version: '2.0'
  x-logo:
    url: https://www.cockroachlabs.com/docs/images/cockroachlabs-logo-170.png
    backgroundColor: '#FFFFFF'
    altText: Cockroach Labs logo
servers:
  - url: https://localhost/api/v2
  - url: http://localhost/api/v2
security: []
paths:
  /health/:
    get:
      summary: Check node health
      description: >-
        Check for node health. If `ready` is true, also check

        if this node is fully operational and ready to accept SQL connections.

        Otherwise, this endpoint always returns a successful response (if the
        API

        server is up).
      operationId: health
      parameters:
        - description: >-
            If true, check whether this node is ready to accept SQL connections.
            If false, this endpoint always returns success, unless the API
            server itself is down.
          name: ready
          in: query
          schema:
            type: boolean
      responses:
        '200':
          description: Indicates healthy node.
        '500':
          description: Indicates unhealthy node.
      x-codeSamples:
        - lang: Shell + Curl
          source: |-
            curl --request GET \
              --url 'https://localhost/api/v2/health/?ready=SOME_BOOLEAN_VALUE'

````