Get health

GET/health

Responses

200

Healthy or degraded

okbooleanrequired

statusstringrequired

Allowed:healthydegradedunhealthy

versionstringrequired

checksobject[]required

Show properties

Array of object

namestringrequired

healthybooleanrequired

messagestring

503

Unhealthy

okbooleanrequired

statusstringrequired

Allowed:healthydegradedunhealthy

versionstringrequired

checksobject[]required

Show properties

Array of object

namestringrequired

healthybooleanrequired

messagestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Request

curl -X GET 'https://pile.nyc/health' \
  -H 'Accept: application/json'

const response = await fetch("https://pile.nyc/health", {
  method: "GET",
  headers: {
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://pile.nyc/health",
    headers={
        "Accept": "application/json"
    },
)

Response

{
  "ok": true,
  "status": "healthy",
  "version": "string",
  "checks": [
    {
      "name": "string",
      "healthy": true,
      "message": "string"
    }
  ]
}

{
  "ok": true,
  "status": "healthy",
  "version": "string",
  "checks": [
    {
      "name": "string",
      "healthy": true,
      "message": "string"
    }
  ]
}