Load capture

Download InfluxDB 3 Enterprise API Spec
Capture an anonymized profile of write requests, query requests, or both on a query-capable node.
GET /api/v3/loadcap/profiles

List load capture profiles

Returns load capture profiles stored by a query-capable Enterprise node that has the performance upgrade preview enabled and an explicit --mode setting that includes query.

This endpoint requires an admin token.

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

Responses

200 Load capture profiles.
401 Unauthorized access.
data object
error string
403 Forbidden. An admin token is required.
404 Load capture is unavailable because this node does not use the performance upgrade preview with an explicit --mode setting that includes query.
POST /api/v3/loadcap/start

Start a load capture

Starts a timed capture of write requests, query requests, or both on a query-capable Enterprise node that has the performance upgrade preview enabled and an explicit --mode setting that includes query.

Only one capture can run at a time on a node. This endpoint requires an admin token.

Request body required

Content-Type: application/json
duration required string
Capture duration using seconds, minutes, or hours. The maximum duration is one hour.
Example: "5m"
type required string
The request types to capture.
Allowed: write , query , both
Example request Ask AI about this
curl --request POST \
  "https://localhost:8181/api/v3/loadcap/start" \
  --header "Authorization: Bearer INFLUX_TOKEN" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "duration": "5m",
  "type": "write"
}'

Responses

200 Load capture started.
profile_id required string <uuid>
Identifier of the new load capture profile.
400 Invalid capture type or duration.
401 Unauthorized access.
data object
error string
403 Forbidden. An admin token is required.
404 Load capture is unavailable because this node does not use the performance upgrade preview with an explicit --mode setting that includes query.
409 A load capture is already running on this node.

Was this page helpful?

Thank you for your feedback!