---
title: "Returns health information about the service."
method: GET
path: "/health"
tags: ["info"]
---

# Returns health information about the service.

`GET /health`

## Request

- Base URL: `https://localhost:8171`
- URL: `https://localhost:8171/health`
- Auth: none required

Returns whether the service is up or not. An in-built Spring endpoint.

## Response `200`

A JSON indicating whether the service is up or not.

- object
  - `status` string

## Other responses

- `404`: The service is incorrectly configured.

---

[API](https://skmtc.dev/office-of-national-statistics/apis/case-service-api.md) - [All operations](https://skmtc.dev/office-of-national-statistics/apis/case-service-api/llms.txt) - [OpenAPI document](https://skmtc.dev/office-of-national-statistics/apis/case-service-api/revisions/6523753b5522?raw)