System information endpoints

Download InfluxDB API Spec
Endpoints for retrieving system-level information about the InfluxDB OSS v2 instance.
GET /api/v2/config

Retrieve runtime configuration

Returns the active runtime configuration of the InfluxDB instance.

In InfluxDB v2.2+, use this endpoint to view your active runtime configuration, including flags and environment variables.

Parameters

Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/api/v2/config" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Success. The response body contains the active runtime configuration of the InfluxDB instance.
config object
401 Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
default Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
GET /api/v2/resources

List all known resources

Parameters

Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/api/v2/resources" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 All resources targets
default Internal server error
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
GET /api/v2

List all top level routes

Retrieves all the top level routes for the InfluxDB API.

Limitations

  • Only returns top level routes–for example, the response contains "tasks":"/api/v2/tasks", and doesn’t contain resource-specific routes for tasks (/api/v2/tasks/TASK_ID/...).

Parameters

Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/api/v2" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Success. The response body contains key-value pairs with the resource name and top-level route.
authorizations string <uri>
buckets string <uri>
dashboards string <uri>
external object
statusFeed string <uri>
flags string <uri>
me string <uri>
orgs string <uri>
query object
analyze string <uri>
ast string <uri>
self string <uri>
suggestions string <uri>
setup string <uri>
signin string <uri>
signout string <uri>
sources string <uri>
system object
debug string <uri>
health string <uri>
metrics string <uri>
tasks string <uri>
telegrafs string <uri>
users string <uri>
variables string <uri>
write string <uri>
GET /debug/pprof/all

Retrieve all runtime profiles

Collects samples and returns reports for the following Go runtime profiles:

  • allocs: All past memory allocations
  • block: Stack traces that led to blocking on synchronization primitives
  • cpu: (Optional) Program counters sampled from the executing stack. Include by passing the cpu query parameter with a duration value. Equivalent to the report from GET /debug/pprof/profile?seconds=NUMBER_OF_SECONDS.
  • goroutine: All current goroutines
  • heap: Memory allocations for live objects
  • mutex: Holders of contended mutexes
  • threadcreate: Stack traces that led to the creation of new OS threads

Parameters

Query parameters
cpu string <duration>
Collects and returns CPU profiling data for the specified duration.
Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/debug/pprof/all" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Go runtime profile reports.
default Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
GET /debug/pprof/allocs

Retrieve the memory allocations runtime profile

Returns a Go runtime profile report of all past memory allocations. allocs is the same as the heap profile, but changes the default pprof display to -alloc_space, the total number of bytes allocated since the program began (including garbage-collected bytes).

Parameters

Query parameters
debug integer <int64>
  • 0: (Default) Return the report as a gzip-compressed protocol buffer.
  • 1: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging.

debug=1 is mutually exclusive with the seconds query parameter.

Allowed values: 0 , 1
seconds string <int64>

Number of seconds to collect statistics.

seconds is mutually exclusive with debug=1.

Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/debug/pprof/allocs" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Go runtime profile report compatible with pprof analysis and visualization tools. If debug is enabled (?debug=1), response body contains a human-readable profile.
default Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
GET /debug/pprof/block

Retrieve the block runtime profile

Collects samples and returns a Go runtime profile report of stack traces that led to blocking on synchronization primitives.

Parameters

Query parameters
debug integer <int64>
  • 0: (Default) Return the report as a gzip-compressed protocol buffer.
  • 1: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging.

debug=1 is mutually exclusive with the seconds query parameter.

Allowed values: 0 , 1
seconds string <int64>

Number of seconds to collect statistics.

seconds is mutually exclusive with debug=1.

Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/debug/pprof/block" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Go runtime profile report compatible with pprof analysis and visualization tools. If debug is enabled (?debug=1), response body contains a human-readable profile.
default Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
GET /debug/pprof/cmdline

Retrieve the command line invocation

Returns the command line that invoked InfluxDB.

Parameters

Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/debug/pprof/cmdline" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Command line invocation.
default Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
GET /debug/pprof/goroutine

Retrieve the goroutines runtime profile

Collects statistics and returns a Go runtime profile report of all current goroutines.

Parameters

Query parameters
debug integer <int64>
  • 0: (Default) Return the report as a gzip-compressed protocol buffer.
  • 1: Return a response body with the report formatted as human-readable text with comments that translate addresses to function names and line numbers for debugging.

debug=1 is mutually exclusive with the seconds query parameter.

Allowed values: 0 , 1
seconds string <int64>

Number of seconds to collect statistics.

seconds is mutually exclusive with debug=1.

Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/debug/pprof/goroutine" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Go runtime profile report compatible with pprof analysis and visualization tools. If debug is enabled (?debug=1), response body contains a human-readable profile.
default Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
GET /debug/pprof/heap

Retrieve the heap runtime profile

Collects statistics and returns a Go runtime profile report of memory allocations for live objects.

To run garbage collection before sampling, pass the gc query parameter with a value of 1.

Parameters

Query parameters
debug integer <int64>
  • 0: (Default) Return the report as a gzip-compressed protocol buffer.
  • 1: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging.

debug=1 is mutually exclusive with the seconds query parameter.

Allowed values: 0 , 1
seconds string <int64>

Number of seconds to collect statistics.

seconds is mutually exclusive with debug=1.

gc integer <int64>
  • 0: (Default) don’t force garbage collection before sampling.
  • 1: Force garbage collection before sampling.
Allowed values: 0 , 1
Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/debug/pprof/heap" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Go runtime profile report compatible with pprof analysis and visualization tools. If debug is enabled (?debug=1), response body contains a human-readable profile.
default Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
GET /debug/pprof/mutex

Retrieve the mutual exclusion (mutex) runtime profile

Collects statistics and returns a Go runtime profile report of lock contentions. The profile contains stack traces of holders of contended mutual exclusions (mutexes).

Parameters

Query parameters
debug integer <int64>
  • 0: (Default) Return the report as a gzip-compressed protocol buffer.
  • 1: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging.

debug=1 is mutually exclusive with the seconds query parameter.

Allowed values: 0 , 1
seconds string <int64>

Number of seconds to collect statistics.

seconds is mutually exclusive with debug=1.

Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/debug/pprof/mutex" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Go runtime profile report compatible with pprof analysis and visualization tools. If debug is enabled (?debug=1), response body contains a human-readable profile.
default Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
GET /debug/pprof/profile

Retrieve the CPU runtime profile

Collects statistics and returns a Go runtime profile report of program counters on the executing stack.

Parameters

Query parameters
seconds string <int64>
Number of seconds to collect profile data. Default is 30 seconds.
Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/debug/pprof/profile" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Go runtime profile report compatible with pprof analysis and visualization tools.
default Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
GET /debug/pprof/threadcreate

Retrieve the threadcreate runtime profile

Collects statistics and returns a Go runtime profile report of stack traces that led to the creation of new OS threads.

Parameters

Query parameters
debug integer <int64>
  • 0: (Default) Return the report as a gzip-compressed protocol buffer.
  • 1: Return a response body with the report formatted as human-readable text. The report contains comments that translate addresses to function names and line numbers for debugging.

debug=1 is mutually exclusive with the seconds query parameter.

Allowed values: 0 , 1
seconds string <int64>

Number of seconds to collect statistics.

seconds is mutually exclusive with debug=1.

Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/debug/pprof/threadcreate" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Go runtime profile report compatible with pprof analysis and visualization tools. If debug is enabled (?debug=1), response body contains a human-readable profile.
default Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
GET /debug/pprof/trace

Retrieve the runtime execution trace

Collects profile data and returns trace execution events for the current program.

Parameters

Query parameters
seconds string <int64>
Number of seconds to collect profile data.
Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/debug/pprof/trace" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Trace file compatible with the Golang trace command.
default Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
GET /health

Retrieve the health of the instance

Returns the health of the instance.

Parameters

Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/health" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 The instance is healthy. The response body contains the health check items and status.
checks object[]
commit string
message string
name required string
status required string
Allowed: pass , fail
version string
503 The instance is unhealthy.
checks object[]
commit string
message string
name required string
status required string
Allowed: pass , fail
version string
default Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
GET /metrics

Retrieve workload performance metrics

Returns metrics about the workload performance of an InfluxDB instance.

Use this endpoint to get performance, resource, and usage metrics.

Parameters

Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/metrics" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200

Success. The response body contains metrics in Prometheus plain-text exposition format Metrics contain a name, an optional set of key-value pairs, and a value.

The following descriptors precede each metric:

default Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.
GET /ping

Get the status of the instance

Retrieves the status and InfluxDB version of the instance.

Use this endpoint to monitor uptime for the InfluxDB instance. The response returns a HTTP 204 status code to inform you the instance is available.

InfluxDB Cloud

  • Isn’t versioned and doesn’t return X-Influxdb-Version in the headers.
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/ping" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

204 Success. Headers contain InfluxDB version information.
GET /ready

Get the readiness of an instance at startup

Parameters

Header parameters
Zap-Trace-Span string
OpenTracing span context
Example request Ask AI about this
curl --request GET \
  "http://localhost:8086/ready" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 The instance is ready
started string <date-time>
Example: "2019-03-13T10:09:33.891196-04:00"
status string
Allowed: ready
up string
Example: "14m45.911966424s"
default Non 2XX error response from server.
code required string
code is the machine-readable error code.
Allowed: internal error , not implemented , not found , conflict , invalid , unprocessable entity , empty value , unavailable , forbidden , too many requests , unauthorized , method not allowed , request too large , unsupported media type
err string
Stack of errors that occurred during processing of the request. Useful for debugging.
message string
Human-readable message.
op string
Describes the logical code operation when the error occurred. Useful for debugging.

Was this page helpful?

Thank you for your feedback!