Check server health

Check whether the API server is ready to accept requests.

GET/api/health

Responses

200Success

healthybooleanrequired

Allowed:true

versionstringrequired

pidobjectrequired

Show properties

object

400InvalidRequestError

_tagstringrequired

Allowed:InvalidRequestError

messagestringrequired

kindstring | any

Show properties

Any of:

string

string

any

any

fieldstring | any

Show properties

Any of:

string

string

any

any

401UnauthorizedError

_tagstringrequired

Allowed:UnauthorizedError

messagestringrequired

Request

curl -X GET "/api/health"

const response = await fetch("/api/health", {
  method: "GET"
});

import requests

response = requests.get(
    "/api/health",
)

Response

{
  "healthy": true,
  "version": "string",
  "pid": {}
}