---
title: "Get service health status."
method: HEAD
path: "/api/health"
tags: ["general"]
---

# Get service health status.

`HEAD /api/health`

Get service health status.

## Query parameters

- `api-version` string, required

## Response `200`

The service is healthy.

## Other responses

- `default` — The error response.

## Changes

- **2026-07-13** (2021-05-01-preview) `3c12a9fc6305` — 1 info
  - api operation id `HealthApi_GetServiceStatus` removed and replaced with `GetServiceStatus`
- **2026-07-13** (2021-05-01-preview) `db70e5df6e15` — 1 breaking
  - the `query` request parameter `api-version` became required
- **2021-04-21** (2021-05-01-preview) `5c057b21a138` — 1 warning, 2 info
  - the optional response header `x-ms-error-code` removed for the status `default`
  - api operation id `GetServiceStatus` removed and replaced with `HealthApi_GetServiceStatus`
  - the `query` request parameter `api-version` became optional

[Change history](https://skmtc.dev/azure/apis/webpubsub/changes/api/health/head.md)

---

[API](https://skmtc.dev/azure/apis/webpubsub.md) · [All operations](https://skmtc.dev/azure/apis/webpubsub/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/azure/webpubsub/revisions/3c12a9fc6305/schema)