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

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[]
Readiness checks that haven’t passed yet. Present only in a 503 response and contains only the failing checks.
checks object[]
checks object[]
commit string
message string
name required string
status required string
Allowed: pass , fail
version string
commit string
message string
name required string
status required string
Allowed: pass , fail
version string
started string <date-time>
Example: "2019-03-13T10:09:33.891196-04:00"
status string
Allowed: ready , starting
up string
Example: "14m45.911966424s"
503 The instance is still starting and isn’t ready yet. One or more readiness checks haven’t passed. The checks property of the response body contains only the failing checks.
checks object[]
Readiness checks that haven’t passed yet. Present only in a 503 response and contains only the failing checks.
checks object[]
checks object[]
commit string
message string
name required string
status required string
Allowed: pass , fail
version string
commit string
message string
name required string
status required string
Allowed: pass , fail
version string
started string <date-time>
Example: "2019-03-13T10:09:33.891196-04:00"
status string
Allowed: ready , starting
up string
Example: "14m45.911966424s"
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!