neosourceDocs
Search docs

Health check

GET/health

healthCheck

Returns a lightweight process health signal for local development and orchestration checks.

Authentication is not described for this operation in the spec — that does not mean it is public. Check tokens and scopes.

curl

curl -X GET 'https://neosource.dev/health'

fetch

fetch("https://neosource.dev/health", {
  method: "GET",
});

Responses

200Service is healthy

application/json

HealthResponse

object

statusrequired

string

example"ok"

Standard errors

Bodies documented once for the whole API — see standard errors.

  • 429Rate limited — retry after the `Retry-After` header
  • 500Internal server error
  • 503Service temporarily unavailable / at capacity — retry after the `Retry-After` header
  • 504Gateway timeout — the request exceeded the server's handling budget