Health

Liveness check

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).

get/health

Request

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

Response

The API process is alive

statusstring

Example response

{
  "status": "ok"
}

Changes

No recorded changes to this operation across all 1 revision of this API.