--- title: System information endpoints description: Endpoints for retrieving system-level information about the InfluxDB OSS v2 instance. url: https://docs.influxdata.com/influxdb/v2/api/system-information-endpoints/ estimated_tokens: 6632 product: InfluxDB OSS v2 version: v2 publisher: InfluxData canonical: https://docs.influxdata.com/influxdb/v2/api/system-information-endpoints/ --- [Download InfluxDB API Spec](/openapi/influxdb-oss-v2-api.yml) 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. #### Related guides * [View your runtime server configuration](/influxdb/v2/reference/config-options/#view-your-runtime-server-configuration) #### Parameters ##### Header parameters `Zap-Trace-Span`string OpenTracing span context Example request[Ask AI about this](#) ```sh curl --request GET \ "http://localhost:8086/api/v2/config" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200Success. The response body contains the active runtime configuration of the InfluxDB instance. `config`object 401Non 2XX error response from server. `code`requiredstring 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. defaultNon 2XX error response from server. `code`requiredstring 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](#) ```sh curl --request GET \ "http://localhost:8086/api/v2/resources" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200All resources targets defaultInternal server error `code`requiredstring 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](#) ```sh curl --request GET \ "http://localhost:8086/api/v2" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200Success. The response body contains key-value pairs with the resource name and top-level route. `authorizations`string \ `buckets`string \ `dashboards`string \ `external`object `statusFeed`string \ `flags`string \ `me`string \ `orgs`string \ `query`object `analyze`string \ `ast`string \ `self`string \ `suggestions`string \ `setup`string \ `signin`string \ `signout`string \ `sources`string \ `system`object `debug`string \ `health`string \ `metrics`string \ `tasks`string \ `telegrafs`string \ `users`string \ `variables`string \ `write`string \ GET`/debug/pprof/all` ### Retrieve all runtime profiles Collects samples and returns reports for the following [Go runtime profiles](https://pkg.go.dev/runtime/pprof): * **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](/influxdb/v2/reference/glossary/#duration) value. Equivalent to the report from [`GET /debug/pprof/profile?seconds=NUMBER_OF_SECONDS`](#operation/GetDebugPprofProfile). * **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 \ Collects and returns CPU profiling data for the specified [duration](/influxdb/v2/reference/glossary/#duration). ##### Header parameters `Zap-Trace-Span`string OpenTracing span context Example request[Ask AI about this](#) ```sh curl --request GET \ "http://localhost:8086/debug/pprof/all" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200[Go runtime profile](https://pkg.go.dev/runtime/pprof) reports. defaultNon 2XX error response from server. `code`requiredstring 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](https://pkg.go.dev/runtime/pprof) report of all past memory allocations.**allocs** is the same as the **heap** profile, but changes the default [pprof](https://pkg.go.dev/runtime/pprof)display to **-alloc\_space**, the total number of bytes allocated since the program began (including garbage-collected bytes). #### Parameters ##### Query parameters `debug`integer \ * `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 \ 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](#) ```sh curl --request GET \ "http://localhost:8086/debug/pprof/allocs" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200[Go runtime profile](https://pkg.go.dev/runtime/pprof) report compatible with [pprof](https://github.com/google/pprof) analysis and visualization tools. If debug is enabled (`?debug=1`), response body contains a human-readable profile. defaultNon 2XX error response from server. `code`requiredstring 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](https://pkg.go.dev/runtime/pprof)report of stack traces that led to blocking on synchronization primitives. #### Parameters ##### Query parameters `debug`integer \ * `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 \ 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](#) ```sh curl --request GET \ "http://localhost:8086/debug/pprof/block" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200[Go runtime profile](https://pkg.go.dev/runtime/pprof) report compatible with [pprof](https://github.com/google/pprof) analysis and visualization tools. If debug is enabled (`?debug=1`), response body contains a human-readable profile. defaultNon 2XX error response from server. `code`requiredstring 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](#) ```sh curl --request GET \ "http://localhost:8086/debug/pprof/cmdline" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200Command line invocation. defaultNon 2XX error response from server. `code`requiredstring 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](https://pkg.go.dev/runtime/pprof)report of all current goroutines. #### Parameters ##### Query parameters `debug`integer \ * `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 \ 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](#) ```sh curl --request GET \ "http://localhost:8086/debug/pprof/goroutine" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200[Go runtime profile](https://pkg.go.dev/runtime/pprof) report compatible with [pprof](https://github.com/google/pprof) analysis and visualization tools. If debug is enabled (`?debug=1`), response body contains a human-readable profile. defaultNon 2XX error response from server. `code`requiredstring 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](https://pkg.go.dev/runtime/pprof)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 \ * `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 \ Number of seconds to collect statistics. `seconds` is mutually exclusive with `debug=1`. `gc`integer \ * `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](#) ```sh curl --request GET \ "http://localhost:8086/debug/pprof/heap" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200[Go runtime profile](https://pkg.go.dev/runtime/pprof) report compatible with [pprof](https://github.com/google/pprof) analysis and visualization tools. If debug is enabled (`?debug=1`), response body contains a human-readable profile. defaultNon 2XX error response from server. `code`requiredstring 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](https://pkg.go.dev/runtime/pprof) report of lock contentions. The profile contains stack traces of holders of contended mutual exclusions (mutexes). #### Parameters ##### Query parameters `debug`integer \ * `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 \ 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](#) ```sh curl --request GET \ "http://localhost:8086/debug/pprof/mutex" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200[Go runtime profile](https://pkg.go.dev/runtime/pprof) report compatible with [pprof](https://github.com/google/pprof) analysis and visualization tools. If debug is enabled (`?debug=1`), response body contains a human-readable profile. defaultNon 2XX error response from server. `code`requiredstring 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](https://pkg.go.dev/runtime/pprof)report of program counters on the executing stack. #### Parameters ##### Query parameters `seconds`string \ 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](#) ```sh curl --request GET \ "http://localhost:8086/debug/pprof/profile" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200[Go runtime profile](https://pkg.go.dev/runtime/pprof) report compatible with [pprof](https://github.com/google/pprof) analysis and visualization tools. defaultNon 2XX error response from server. `code`requiredstring 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](https://pkg.go.dev/runtime/pprof)report of stack traces that led to the creation of new OS threads. #### Parameters ##### Query parameters `debug`integer \ * `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 \ 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](#) ```sh curl --request GET \ "http://localhost:8086/debug/pprof/threadcreate" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200[Go runtime profile](https://pkg.go.dev/runtime/pprof) report compatible with [pprof](https://github.com/google/pprof) analysis and visualization tools. If debug is enabled (`?debug=1`), response body contains a human-readable profile. defaultNon 2XX error response from server. `code`requiredstring 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 \ Number of seconds to collect profile data. ##### Header parameters `Zap-Trace-Span`string OpenTracing span context Example request[Ask AI about this](#) ```sh curl --request GET \ "http://localhost:8086/debug/pprof/trace" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200[Trace file](https://pkg.go.dev/runtime/trace) compatible with the [Golang `trace` command](https://pkg.go.dev/cmd/trace). defaultNon 2XX error response from server. `code`requiredstring 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](#) ```sh curl --request GET \ "http://localhost:8086/health" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200The instance is healthy. The response body contains the health check items and status. `checks`object[] `commit`string `message`string `name`requiredstring `status`requiredstring Allowed:`pass`, `fail` `version`string 503The instance is unhealthy. `checks`object[] `commit`string `message`string `name`requiredstring `status`requiredstring Allowed:`pass`, `fail` `version`string defaultNon 2XX error response from server. `code`requiredstring 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. #### Related guides * For the list of metrics categories, see [InfluxDB OSS metrics](/influxdb/v2/reference/internals/metrics/). * Learn how to use InfluxDB to [scrape Prometheus metrics](/influxdb/v2/write-data/developer-tools/scrape-prometheus-metrics/). * Learn how InfluxDB [parses the Prometheus exposition format](/influxdb/v2/reference/prometheus-metrics/). #### Parameters ##### Header parameters `Zap-Trace-Span`string OpenTracing span context Example request[Ask AI about this](#) ```sh 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](https://prometheus.io/docs/instrumenting/exposition_formats)Metrics contain a name, an optional set of key-value pairs, and a value. The following descriptors precede each metric: * `HELP`: description of the metric * `TYPE`: [Prometheus metric type](https://prometheus.io/docs/concepts/metric_types/) (`counter`, `gauge`, `histogram`, or `summary`) defaultNon 2XX error response from server. `code`requiredstring 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. #### Related guides * [Influx ping](/influxdb/v2/reference/cli/influx/ping/) Example request[Ask AI about this](#) ```sh curl --request GET \ "http://localhost:8086/ping" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 204Success. 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](#) ```sh curl --request GET \ "http://localhost:8086/ready" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200The instance is ready `started`string \ Example:`"2019-03-13T10:09:33.891196-04:00"` `status`string Allowed:`ready` `up`string Example:`"14m45.911966424s"` defaultNon 2XX error response from server. `code`requiredstring 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.