System Information

Download InfluxDB Enterprise v1 API Spec
Check server status, health, and version information for an InfluxDB Enterprise v1 instance.
GET /ping

Check server status

Check the status of your InfluxDB Enterprise instance and retrieve version information. The /ping endpoint returns a 204 No Content response by default.

Use the verbose=true query parameter to return a 200 OK response, which is required for Google Cloud Load Balancing health checks.

Parameters

Query parameters
verbose boolean
When true, returns HTTP 200 instead of 204. Required for Google Cloud Load Balancing health checks.
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/ping" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Server is running (verbose mode)
204 Server is running
HEAD /ping

Check server status (HEAD)

Check the status of your InfluxDB Enterprise instance using a HEAD request. Returns the same headers as GET but without a response body.
Example request Ask AI about this
curl --request HEAD \
  "http://localhost:8086/ping" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

204 Server is running
GET /shard-status

Get shard status

Enterprise only. Retrieve information about all shards on the data node, including shard ID, size, hot status, and anti-entropy state.
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/shard-status" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Shard status for all databases
databases object[]
name string
Database name
retention_policies object[]
name string
Retention policy name
replication_factor integer
Replication factor
shards object[]
GET /health v2

Check server health

Check the health of your InfluxDB Enterprise instance. Returns health status as JSON with a pass or fail status.
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/health" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Server is healthy
message string
Example: "ready for queries and writes"
name string
Example: "influxdb"
status string
Allowed: pass , fail
version string
Example: "1.12.2"
503 Server is unhealthy
message string
Example: "ready for queries and writes"
name string
Example: "influxdb"
status string
Allowed: pass , fail
version string
Example: "1.12.2"

Was this page helpful?

Thank you for your feedback!