---
title: "list"
method: GET
path: "/v1/health"
tags: ["Health"]
---

# list

`GET /v1/health`

## Request

- Base URL: `https://api.groundx.ai/api`
- URL: `https://api.groundx.ai/api/v1/health`
- Auth: API key in header `X-API-Key`

List the current health status of all services. Statuses update every 5 minutes.

## Response `200`

Look up success

- HealthResponse
  - `health` object, required
    - `services` HealthService[], required
      - `lastUpdate` string, date-time, required: The data time when the service status was last updated, in RFC3339 format
      - `service` string, required: The name of the service
      - `status` 'healthy' | 'degraded' | 'down' | 'unknown', required: The health status of the service

## Changes

- **2024-06-03** `6e06ce07d412`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/groundxai/apis/groundx-apis/changes/v1/health/get.md)

---

[API](https://skmtc.dev/groundxai/apis/groundx-apis.md) - [All operations](https://skmtc.dev/groundxai/apis/groundx-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/groundxai/apis/groundx-apis/revisions/1c1a5c17f52f?raw)