Server information

Download InfluxDB 3 Enterprise API Spec
Retrieve server metrics, health status, and version information for InfluxDB 3 Enterprise.
POST /api/v3/enterprise/configure/node/stop

Mark a node as stopped

Marks a node as stopped in the catalog, freeing up the licensed cores it was using for other nodes.

Use this endpoint after you have already stopped the physical instance (for example, using kill or stopping the container). This endpoint does not shut down the running process — you must stop the instance first.

When the node is marked as stopped:

  1. Licensed cores from the stopped node are freed for reuse
  2. Other nodes in the cluster see the update after their catalog sync interval

This endpoint is only available in InfluxDB 3 Enterprise.

Request body required

Content-Type: application/json
node_id required string
The ID of the node to mark as stopped.
Example request body
{
  "node_id": "node-1"
}
Example request Ask AI about this
curl --request POST \
  "https://localhost:8181/api/v3/enterprise/configure/node/stop" \
  --header "Authorization: Bearer INFLUX_TOKEN" \
  --header "Content-Type: application/json" \
  --data-raw '{"node_id":"node-1"}'

Responses

200 Success. The node has been marked as stopped.
401 Unauthorized access.
data object
error string
404 Node not found.
GET /api/v1/health

Health check (v1)

Checks the status of the service.

Returns OK if the service is running. This endpoint does not return version information. Use the /ping endpoint to retrieve version details.

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

Example request Ask AI about this
curl --request GET \
  "https://localhost:8181/api/v1/health" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Service is running. Returns OK.
401 Unauthorized. Authentication is required.
500 Service is unavailable.
GET /health

Health check

Checks the status of the service.

Returns OK if the service is running. This endpoint does not return version information. Use the /ping endpoint to retrieve version details.

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

Example request Ask AI about this
curl --request GET \
  "https://localhost:8181/health" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Service is running. Returns OK.
401 Unauthorized. Authentication is required.
500 Service is unavailable.
GET /metrics

Metrics

Retrieves Prometheus-compatible server metrics.
Example request Ask AI about this
curl --request GET \
  "https://localhost:8181/metrics" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Success
GET /ping

Ping the server

Returns version information for the server.

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

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 Enterprise.

Example request Ask AI about this
curl --request GET \
  "https://localhost:8181/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.
POST /ping

Ping the server

Returns version information for the server. Accepts POST in addition to GET.
Example request Ask AI about this
curl --request POST \
  "https://localhost:8181/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!