Ready

Download InfluxDB API Spec
Check whether an InfluxDB OSS v2 instance is ready to accept requests.
GET /ready

Get the readiness of an instance at startup

Returns the readiness of the instance.

--health-auth-mode and --hardening-enabled can withhold checks from callers without operator permissions. They never change the status code.

Parameters

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

Responses

200 The instance is ready
checks object[]
Ready gates that haven’t passed. Omitted when status is ready.
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.
started string <date-time>
Example: "2019-03-13T10:09:33.891196-04:00"
status string
Allowed: ready , starting
up string
Example: "14m45.911966424s"
uptime object
Time since started, in float seconds.
Example: {"completed":94,"total":200,"unit":"shards"}
unit required string
Example: "shards"
503 The instance is starting or shutting down. checks contains only the ready gates that haven’t passed.
checks object[]
Ready gates that haven’t passed. Omitted when status is ready.
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.
started string <date-time>
Example: "2019-03-13T10:09:33.891196-04:00"
status string
Allowed: ready , starting
up string
Example: "14m45.911966424s"
uptime object
Time since started, in float seconds.
Example: {"completed":94,"total":200,"unit":"shards"}
unit required string
Example: "shards"
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!