---
title: "Service Health Check"
method: GET
path: "/v1/liveness"
tags: ["liveness"]
---

# Service Health Check

`GET /v1/liveness`

This endpoint provides a simple health check to verify that the Steamsets API is operational and ready to serve requests.

<Info>
This endpoint is commonly used by load balancers, monitoring systems, and container orchestrators to check service availability.
</Info>

<Tip>
Use this endpoint for automated health monitoring - it has minimal overhead and responds quickly.
</Tip>

## Use Cases

- **Load Balancer Health Checks**: Configure your load balancer to ping this endpoint
- **Monitoring Systems**: Set up alerts when this endpoint becomes unavailable
- **Container Health Checks**: Use in Docker/Kubernetes health check configurations
- **API Status Verification**: Quick way to verify the service is responding

## Response Format

The endpoint returns a simple JSON object with a status message confirming the service is alive and operational.

## Response `200`

OK

- V1LivenessResponseBody
  - `$schema` string, uri — A URL to the JSON Schema for this object.
  - `message` string, required — Whether we're alive or not

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

---

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