Server information

Download InfluxDB 3 Cloud API Spec

Retrieve health status and version information for your InfluxDB 3 Cloud instance.

Note: InfluxDB 3 Cloud doesn’t support the /health endpoint available in InfluxDB 3 Core and Enterprise. Requests to /health return 404 Not Found. Use /ping instead.

GET /ping

Ping the server

Returns version information for the server.

Important: Use a GET request. HEAD requests return 404 Not Found.

Note: Unlike InfluxDB 3 Core and Enterprise, InfluxDB 3 Cloud doesn’t support the /health endpoint. Requests to /health return 404 Not Found. Use /ping to check instance reachability and retrieve version information.

The response includes version information in both headers and the JSON body:

  • Headers: x-influxdb-version and x-influxdb-build
  • Body: JSON object with version, revision, and process_id

Note: This endpoint requires authentication by default in InfluxDB 3 Cloud.

Example request Ask AI about this
curl --request GET \
  "https://cluster-host.a.influxdb.io/ping" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Success. The response body contains server information.
process_id string
A unique identifier for the server process.
Example: "b756d9e0-cecd-4f72-b6d0-19e2d4f8cbb7"
revision string
The git revision hash for the build.
Example: "83b589b883"
version string
The InfluxDB version number.
Example: "3.8.0"
401 Unauthorized. Authentication is required.
404 Not Found. Returned for HEAD requests. Use a GET request to retrieve version information.

Was this page helpful?

Thank you for your feedback!