---
title: "Reports the health status of the service."
method: GET
path: "/healthCheck"
tags: ["HealthCheck"]
---

# Reports the health status of the service.

`GET /healthCheck`

Checks the health of the service and returns a status response.

## Response `201`

Created

- HealthCheckResponse — Response container for details responding to a health check request. Inherits from Gd.Bos.DataTransfer.Response.ResponseBase and provides a property for health check details.
  - `healthCheck` HealthCheck — Represents the health check details of a service, including its status, timing information, and dependencies.
    - `serviceName` string, nullable — Gets or sets the name of the service being checked.
    - `status` string, nullable — Gets or sets the current health status of the service (e.g., "Healthy", "Unhealthy").
    - `totalTime` string, nullable — Gets or sets the total time taken to perform the health check, typically represented as a string (e.g., "00:00:01.234").
    - `waitTime` object, nullable — Gets or sets a dictionary containing wait times for various operations or dependencies, where the key is the operation name and the value is the wait time as a string.
    - `dependencies` HealthCheck[], nullable — Gets or sets the list of health check results for dependent services.
  - `responseDetails` ResponseDetail[], nullable — Required: A list of response details providing status codes, descriptions, and additional information about the result of the operation.
    - `code` integer — The primary status or error code for the response (e.g., 200 for success, 400 for validation error).
    - `subCode` integer, nullable — An optional subcode providing more granular detail about the response or error.
    - `description` string, nullable — A human-readable description of the response, error, or status.
    - `url` string, nullable — A URL linking to documentation or a web page with more information about the response code.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/greendot/apis/baas-apis.md) · [All operations](https://skmtc.net/greendot/apis/baas-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/greendot/baas-apis/versions/666553766b78/schema)