Query groups

Download InfluxDB 3 Enterprise API Spec

Manage distributed query groups–named sets of query nodes that InfluxDB 3 Enterprise load-balances queries across.

Not yet operational: These endpoints work and store query group definitions in the catalog, but InfluxDB 3 Enterprise doesn’t yet use those definitions to affect query routing, data placement, or replication.

GET /api/v3/enterprise/configure/query_groups Not operational

List distributed query groups (not yet operational)

Reserved for the distributed query group feature.

Not yet operational: Request and response fields aren’t finalized, and InfluxDB 3 Enterprise doesn’t yet use query group definitions to affect query routing, data placement, or replication.

This endpoint is only available in InfluxDB 3 Enterprise.

Example request Ask AI about this
curl --request GET \
  "https://localhost:8181/api/v3/enterprise/configure/query_groups" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Success. Not documented. This endpoint is not yet operational; response fields aren’t finalized.
401 Unauthorized access.
data object
error string
POST /api/v3/enterprise/configure/query_groups Not operational

Create a distributed query group (not yet operational)

Reserved for the distributed query group feature.

Not yet operational: Request and response fields aren’t finalized, and InfluxDB 3 Enterprise doesn’t yet use query group definitions to affect query routing, data placement, or replication.

This endpoint is only available in InfluxDB 3 Enterprise.

Request body required

Content-Type: application/json
Example request Ask AI about this
curl --request POST \
  "https://localhost:8181/api/v3/enterprise/configure/query_groups" \
  --header "Authorization: Bearer INFLUX_TOKEN" \
  --header "Content-Type: application/json"

Responses

201 Created. Not documented. This endpoint is not yet operational; response fields aren’t finalized.
400

Request failed. Possible reasons:

  • Invalid database name
  • Malformed request body
  • Invalid timestamp precision
data object
error string
401 Unauthorized access.
data object
error string
GET /api/v3/enterprise/configure/query_groups/{id} Not operational

Retrieve a distributed query group (not yet operational)

Reserved for the distributed query group feature.

Not yet operational: Request and response fields aren’t finalized, and InfluxDB 3 Enterprise doesn’t yet use query group definitions to affect query routing, data placement, or replication.

This endpoint is only available in InfluxDB 3 Enterprise.

Parameters

Path parameters
id required integer
The ID of the query group.
Example request Ask AI about this
curl --request GET \
  "https://localhost:8181/api/v3/enterprise/configure/query_groups/{id}" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Success. Not documented. This endpoint is not yet operational; response fields aren’t finalized.
401 Unauthorized access.
data object
error string
404 Query group not found.
PUT /api/v3/enterprise/configure/query_groups/{id} Not operational

Replace a distributed query group (not yet operational)

Reserved for the distributed query group feature.

Not yet operational: Request and response fields aren’t finalized, and InfluxDB 3 Enterprise doesn’t yet use query group definitions to affect query routing, data placement, or replication.

This endpoint is only available in InfluxDB 3 Enterprise.

Parameters

Path parameters
id required integer
The ID of the query group.

Request body required

Content-Type: application/json
Example request Ask AI about this
curl --request PUT \
  "https://localhost:8181/api/v3/enterprise/configure/query_groups/{id}" \
  --header "Authorization: Bearer INFLUX_TOKEN" \
  --header "Content-Type: application/json"

Responses

200 Success. Not documented. This endpoint is not yet operational; response fields aren’t finalized.
400

Request failed. Possible reasons:

  • Invalid database name
  • Malformed request body
  • Invalid timestamp precision
data object
error string
401 Unauthorized access.
data object
error string
404 Query group not found.
PATCH /api/v3/enterprise/configure/query_groups/{id} Not operational

Update a distributed query group (not yet operational)

Reserved for the distributed query group feature.

Not yet operational: Request and response fields aren’t finalized, and InfluxDB 3 Enterprise doesn’t yet use query group definitions to affect query routing, data placement, or replication.

This endpoint is only available in InfluxDB 3 Enterprise.

Parameters

Path parameters
id required integer
The ID of the query group.

Request body required

Content-Type: application/json
Example request Ask AI about this
curl --request PATCH \
  "https://localhost:8181/api/v3/enterprise/configure/query_groups/{id}" \
  --header "Authorization: Bearer INFLUX_TOKEN" \
  --header "Content-Type: application/json"

Responses

200 Success. Not documented. This endpoint is not yet operational; response fields aren’t finalized.
400

Request failed. Possible reasons:

  • Invalid database name
  • Malformed request body
  • Invalid timestamp precision
data object
error string
401 Unauthorized access.
data object
error string
404 Query group not found.
DELETE /api/v3/enterprise/configure/query_groups/{id} Not operational

Delete a distributed query group (not yet operational)

Reserved for the distributed query group feature.

Not yet operational: Request and response fields aren’t finalized, and InfluxDB 3 Enterprise doesn’t yet use query group definitions to affect query routing, data placement, or replication.

This endpoint is only available in InfluxDB 3 Enterprise.

Parameters

Path parameters
id required integer
The ID of the query group.
Example request Ask AI about this
curl --request DELETE \
  "https://localhost:8181/api/v3/enterprise/configure/query_groups/{id}" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Success. The query group has been deleted.
401 Unauthorized access.
data object
error string
404 Query group not found.

Was this page helpful?

Thank you for your feedback!