How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

gRPC Health Checking Service

The gRPC Health Checking Protocol defines a standard service that gRPC servers implement to expose health status information to clients and load balancers. Servers implement the Health service proto to report per-service readiness, and clients can configure automatic health-check-based connection management.

gRPC Health Checking Service is one of 7 APIs that gRPC publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

Tagged areas include Health Checking, Load Balancing, and Observability. The published artifact set on APIs.io includes API documentation, an API reference, a GitHub repository, and an AsyncAPI specification.

This event API exposes 6 operations across 3 channels, and defines 8 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.0.

The API connects through 2 servers: {host}:{port} (grpc), {proxyHost}:{proxyPort} (https).

6 operations 3 channels 8 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
1.0.0
Servers
{host}:{port} (grpc)
{proxyHost}:{proxyPort} (https)
License
Resource Areas
1

Channels & Operations 6

Across 3 channels, the API surfaces 6 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 6
SUB
/grpc.health.v1.Health/Watch
Stream health status changes for a service
watchHealthStatus body
PUB
/grpc.health.v1.Health/Watch
Send a health watch request
sendHealthWatchRequest body
SUB
/grpc.reflection.v1alpha.ServerReflection/ServerReflectionInfo
Receive a server reflection response
receiveReflectionResponse body
PUB
/grpc.reflection.v1alpha.ServerReflection/ServerReflectionInfo
Send a server reflection request
sendReflectionRequest body
SUB
/grpc.health.v1.Health/Check
Receive a unary health check response
receiveHealthCheckResponse body
PUB
/grpc.health.v1.Health/Check
Send a unary health check request
sendHealthCheckRequest body

Messages & Schemas 8

The contract defines 8 schemas that model the data carried by its messages. The most detailed are ServerReflectionResponse (6 properties), ServerReflectionRequest (6 properties), HealthCheckResponse (1 property), HealthCheckRequest (1 property). Each schema is shown below with its type and property counts.

HealthCheckRequest
message
Request to check or watch the health of a named gRPC service
HealthCheckResponse
message
Health status of a gRPC service
ServerReflectionRequest
message
Request for service or type information from the reflection service
ServerReflectionResponse
message
Response containing service definitions or metadata from the reflection service
HealthCheckRequest
object
Request message for both the Check and Watch RPCs of the gRPC Health Checking Protocol (grpc.health.v1).
1 property
HealthCheckResponse
object
Response message from the gRPC Health Checking Protocol containing the current serving status of the queried service.
1 property 1 required
ServerReflectionRequest
object
Request message for the gRPC Server Reflection service (grpc.reflection.v1alpha.ServerReflection). Exactly one of the query fields must be set.
6 properties
ServerReflectionResponse
object
Response message from the gRPC Server Reflection service. Contains the echoed original request and exactly one response body field.
6 properties

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

asyncapi.yml Raw ↑

Other APIs gRPC publishes across the network.

gRPC Core Framework
Protocol Buffers Service Definition Schema
gRPC Server Reflection
gRPC Channelz API
gRPC Health Checking API
gRPC Reflection API
Where this information came from

This is an independent, third-party profile of gRPC Health Checking Service, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.