---
title: "Liveness check"
method: GET
path: "/health"
tags: ["Health"]
---

# Liveness check

`GET /health`

## Request

- Base URL: `https://api.faireplace.com/api`
- URL: `https://api.faireplace.com/api/health`
- Auth: none required

Answers `200` as long as the process is up. **Does not touch the
database**: this is the endpoint uptime monitors should poll.

Use `/ready` instead when you need to know the API can actually serve
traffic (deployment gates, smoke tests).

## Response `200`

The API process is alive

- object
  - `status` string

## Other responses

- `429`: Rate limit exceeded. Every endpoint sits behind a plan-aware limiter, and the public tools carry an additional per-endpoint one. `error.details.retry_after_seconds` says how long to wait; the `Retry-After`, `X-RateLimit-Limit` and `X-RateLimit-Remaining` headers carry the same information.

---

[API](https://skmtc.dev/faireplace/apis/faireplace-property-management-api.md) · [All operations](https://skmtc.dev/faireplace/apis/faireplace-property-management-api/llms.txt) · [OpenAPI document](https://skmtc.dev/faireplace/apis/faireplace-property-management-api/revisions/69de39762919?raw)
