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.
GET /api/v3/loadcap/profiles/{profile_id}

Retrieve load capture profile details

Returns file counts, total size, and an anonymized catalog summary for a load capture profile. The response is the same as the profile preview.

This endpoint requires an admin token.

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

Responses

200 Load capture profile details.
catalog_summary object
Anonymized catalog snapshot taken when the capture started, including databases, tables, columns, and node metadata. Null for query-only captures.
file_count integer
Total number of files in the profile archive.
profile_id string <uuid>
Identifier of the load capture profile.
query_count integer
Number of captured queries in the profile.
total_size_bytes integer
Total size of the profile archive contents, in bytes.
wal_file_count integer
Number of anonymized write-ahead log (.pt) files in the profile.
401 Unauthorized access.
data object
error string
403 Forbidden. An admin token is required.
404 The profile does not exist, or load capture is unavailable because this node does not use the performance upgrade preview with an explicit --mode setting that includes query.
DELETE /api/v3/loadcap/profiles/{profile_id}

Delete a load capture profile

Deletes a load capture profile and its stored artifacts from object storage.

This endpoint requires an admin token.

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

Responses

200 The profile was deleted.
401 Unauthorized access.
data object
error string
403 Forbidden. An admin token is required.
404 The profile does not exist, or load capture is unavailable because this node does not use the performance upgrade preview with an explicit --mode setting that includes query.
GET /api/v3/loadcap/profiles/{profile_id}/download

Download a load capture profile

Downloads the load capture profile as a gzipped tar archive containing the anonymized capture artifacts—catalog.json and .pt write-ahead log files for write and both captures, and queries.json.zst for query and both captures.

This endpoint requires an admin token.

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

Responses

200 The profile archive. The response Content-Type is application/gzip and Content-Disposition provides the {profile_id}.tar.gz filename.
401 Unauthorized access.
data object
error string
403 Forbidden. An admin token is required.
404 The profile does not exist, or load capture is unavailable because this node does not use the performance upgrade preview with an explicit --mode setting that includes query.
GET /api/v3/loadcap/profiles/{profile_id}/preview

Preview a load capture profile

Returns file counts, total size, and an anonymized catalog summary for a load capture profile without downloading the archive. For query-only captures, catalog_summary is null.

This endpoint requires an admin token.

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

Responses

200 Load capture profile preview.
catalog_summary object
Anonymized catalog snapshot taken when the capture started, including databases, tables, columns, and node metadata. Null for query-only captures.
file_count integer
Total number of files in the profile archive.
profile_id string <uuid>
Identifier of the load capture profile.
query_count integer
Number of captured queries in the profile.
total_size_bytes integer
Total size of the profile archive contents, in bytes.
wal_file_count integer
Number of anonymized write-ahead log (.pt) files in the profile.
401 Unauthorized access.
data object
error string
403 Forbidden. An admin token is required.
404 The profile does not exist, or 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!