Debug

Download InfluxDB Enterprise v1 API Spec
Access debugging and profiling endpoints for troubleshooting and performance analysis of an InfluxDB Enterprise v1 instance.
GET /debug/pprof

Get profiling index

Returns an HTML page listing available Go pprof profiles. Use the individual profile endpoints to retrieve specific profile data.
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/debug/pprof" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 HTML page with profile links
GET /debug/pprof/{profile}

Get profile data

Retrieve a specific Go pprof profile. Available profiles:

  • block: Stack traces that led to blocking on synchronization primitives
  • goroutine: Stack traces of all current goroutines
  • heap: Sampling of stack traces for heap allocations
  • mutex: Stack traces of holders of contended mutexes
  • threadcreate: Stack traces that led to creation of new OS threads
  • profile: CPU profile (use seconds parameter to specify duration)
  • trace: Execution trace (use seconds parameter to specify duration)

Parameters

Path parameters
profile required string
Profile name
Allowed values: block , goroutine , heap , mutex , threadcreate , profile , trace , allocs , cmdline
Query parameters
seconds integer
Duration in seconds for CPU profile or trace
Default: 30
debug integer
Return human-readable text output instead of binary
Allowed values: 0 , 1
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/debug/pprof/{profile}" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Profile data
GET /debug/pprof/all

Get all profiles archive

Generate a profiles.tar.gz archive containing all standard Go profiling information and additional debugging data. Intended primarily for use by InfluxData support.

Use the cpu parameter to include a CPU profile of the specified duration.

Parameters

Query parameters
cpu string
Duration for CPU profile. Specify as a duration string (e.g., 30s).
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/debug/pprof/all" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Compressed archive containing all profiles
GET /debug/requests

Track HTTP requests

Track HTTP client requests to the /write and /query endpoints. Returns the number of writes and queries per username and IP address over the specified time interval.

Parameters

Query parameters
seconds integer
Duration in seconds to collect request data
Default: 10
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/debug/requests" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Request statistics by user and IP
GET /debug/vars

Get server statistics

Retrieve runtime statistics and information about the InfluxDB Enterprise instance. Returns detailed metrics in JSON format including memory usage, goroutine counts, and database statistics.

The InfluxDB Telegraf input plugin can collect these metrics automatically.

Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/debug/vars" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Server statistics in JSON format

Was this page helpful?

Thank you for your feedback!