Health

Download InfluxDB API Spec
Check the health and readiness of an InfluxDB OSS v2 instance.
GET /health

Retrieve the health of the instance

Returns the health of the instance.

--health-auth-mode and --hardening-enabled reduce the response body for callers without operator permissions. Those callers don’t receive check messages, measure groups, version, or commit. The status code never changes.

Parameters

Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/health" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 The instance is healthy. The response body contains the health check items and status.
checks object[]
checks object[]
checks object[]
commit string
Build commit. Returned only at the top level.
message string
Status detail. For a failing check, may contain the raw error text.
name required string
status required string
Allowed: pass , fail
version string
Build version. Returned only at the top level.
commit string
Build commit. Returned only at the top level.
message string
Status detail. For a failing check, may contain the raw error text.
name required string
status required string
Allowed: pass , fail
version string
Build version. Returned only at the top level.
commit string
Build commit. Returned only at the top level.
message string
Status detail. For a failing check, may contain the raw error text.
name required string
status required string
Allowed: pass , fail
version string
Build version. Returned only at the top level.
503 The instance is unhealthy. message contains the message of the first failing check.
checks object[]
checks object[]
checks object[]
commit string
Build commit. Returned only at the top level.
message string
Status detail. For a failing check, may contain the raw error text.
name required string
status required string
Allowed: pass , fail
version string
Build version. Returned only at the top level.
commit string
Build commit. Returned only at the top level.
message string
Status detail. For a failing check, may contain the raw error text.
name required string
status required string
Allowed: pass , fail
version string
Build version. Returned only at the top level.
commit string
Build commit. Returned only at the top level.
message string
Status detail. For a failing check, may contain the raw error text.
name required string
status required string
Allowed: pass , fail
version string
Build version. Returned only at the top level.
default Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.

Was this page helpful?

Thank you for your feedback!