gRPC Health Checking API

gRPC Health Checking Protocol endpoints for monitoring service availability and readiness.

Operations 2

POST /grpc.health.v1.Health/Check gRPC Check service health #
POST /grpc.health.v1.Health/Watch gRPC Watch service health changes #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/grpc-health-checking-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

grpc-health-checking-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: gRPC-Web Proxy Health Checking API
  description: OpenAPI specification for gRPC-Web proxy endpoints. gRPC-Web is a JavaScript client library that enables browser-based applications to communicate with gRPC services through an intermediary proxy. The proxy translates HTTP/1.1 and HTTP/2 requests into native gRPC calls, exposing health checking, reflection, and channelz services over RESTful HTTP endpoints.
  version: 1.0.0
  contact:
    name: gRPC Authors
    url: https://grpc.io/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://localhost:8080
  description: Local gRPC-Web proxy
tags:
- name: Health Checking
  description: gRPC Health Checking Protocol endpoints for monitoring service availability and readiness.
paths:
  /grpc.health.v1.Health/Check:
    post:
      operationId: healthCheck
      summary: gRPC Check service health
      description: Performs a health check against a specific gRPC service or the overall server. Implements the gRPC Health Checking Protocol as defined in the grpc.health.v1 package.
      tags:
      - Health Checking
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HealthCheckRequest'
      responses:
        '200':
          description: Health check response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
        '404':
          description: Service not found
        '503':
          description: Service unhealthy
  /grpc.health.v1.Health/Watch:
    post:
      operationId: healthWatch
      summary: gRPC Watch service health changes
      description: Opens a server-streaming connection that sends health status updates whenever the health of the requested service changes.
      tags:
      - Health Checking
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HealthCheckRequest'
      responses:
        '200':
          description: Stream of health check responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
components:
  schemas:
    HealthCheckResponse:
      type: object
      required:
      - status
      properties:
        status:
          type: string
          enum:
          - UNKNOWN
          - SERVING
          - NOT_SERVING
          - SERVICE_UNKNOWN
          description: The health status of the requested service.
    HealthCheckRequest:
      type: object
      properties:
        service:
          type: string
          description: The fully-qualified service name to check. An empty string or omitted value checks the overall server health.
externalDocs:
  description: gRPC Documentation
  url: https://grpc.io/docs/