---
title: "Gets project's service health status"
method: GET
path: "/v1/projects/{ref}/health"
tags: ["Projects"]
---

# Gets project's service health status

`GET /v1/projects/{ref}/health`

## Path parameters

- `ref` string, required

## Query parameters

- `services` string[], required
- `timeout_ms` integer

## Response `200`

- V1ServiceHealthResponse[]
  - `name` 'auth' | 'db' | 'db_postgres_user' | 'pooler' | 'realtime' | 'rest' | 'storage' | 'pg_bouncer', required
  - `healthy` boolean, required — Deprecated. Use `status` instead.
  - `status` 'COMING_UP' | 'ACTIVE_HEALTHY' | 'UNHEALTHY', required
  - `info` union
    - object
      - `name` 'GoTrue', required
      - `version` string, required
      - `description` string, required
    - object
      - `healthy` boolean, required — Deprecated. Use `status` instead.
      - `db_connected` boolean, required
      - `replication_connected` boolean, required
      - `connected_cluster` integer, required
    - object
      - `db_schema` string, required
  - `error` string

## Other responses

- `401` — Unauthorized
- `403` — Forbidden action
- `429` — Rate limit exceeded
- `500` — Failed to retrieve project's service health status

---

[API](https://skmtc.net/supabase/apis/management-api.md) · [All operations](https://skmtc.net/supabase/apis/management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/supabase/management-api/versions/a7cb39418064/schema)