---
title: "set a gRPC health serving status"
method: PUT
path: "/mockserver/grpc/health"
tags: ["grpc"]
---

# set a gRPC health serving status

`PUT /mockserver/grpc/health`

## Request

- Base URL: `http://localhost:1080`
- URL: `http://localhost:1080/mockserver/grpc/health`
- Auth: none declared

Sets the gRPC health-checking serving status for a service (an empty service name sets the default), or removes a service override with 'remove':true.

## Request body

- object
  - `service` string: gRPC service name; an empty string sets the overall server status (the empty service name defined by the gRPC health checking protocol), rather than the status of any named service
  - `status` 'UNKNOWN' | 'SERVING' | 'NOT_SERVING' | 'SERVICE_UNKNOWN'
  - `remove` boolean: when true, removes the service override

## Response `200`

serving status set or removed

- object
  - `status` string
  - `service` string
  - `servingStatus` string

## Other responses

- `400`: missing or invalid 'service' / 'status' fields

---

[API](https://skmtc.dev/mock-server/apis/mockserver-api.md) · [All operations](https://skmtc.dev/mock-server/apis/mockserver-api/llms.txt) · [OpenAPI document](https://skmtc.dev/mock-server/apis/mockserver-api/revisions/9239b693996e?raw)