---
title: "Service health check"
method: GET
path: "/api/v1/health"
tags: ["System"]
---

# Service health check

`GET /api/v1/health`

## Request

- Base URL: `https://www.venumark.com`
- URL: `https://www.venumark.com/api/v1/health`
- Auth: none required

Liveness probe. Public (no authentication). Targeted by the api-catalog status relation.

## Response `200`

Service is up.

- HealthEnvelope
  - `data` object, required
    - `status` string, required
    - `time` string, date-time
  - `meta` EnvelopeMeta, nullable: Optional response metadata, e.g. {count}. List endpoints are unpaginated and return the full result set. Null when not applicable.
  - `error` unknown, required

---

[API](https://skmtc.dev/venumark/apis/venumark-read-api.md) · [All operations](https://skmtc.dev/venumark/apis/venumark-read-api/llms.txt) · [OpenAPI document](https://skmtc.dev/venumark/apis/venumark-read-api/revisions/3bd019092f9c?raw)