Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

InfluxData System information endpoints API

The System information endpoints API from InfluxData — 17 operation(s) for system information endpoints.

InfluxData System information endpoints API is one of 45 APIs that InfluxData publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include System information endpoints. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide.

This API exposes 17 operations across 17 paths, and defines 5 schemas. It is described by OpenAPI 3.0.0, at version 2.0.1.

Requests are made against a single base URL, /api/v2.

17 operations 17 paths 5 schemas 17 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.1
Base URL
https://us-east-1-1.aws.cloud2.influxdata.com/api/v2
Authentication
API Key, HTTP Basic
License
Resource Areas
1

Authentication & Security 2

InfluxData System information endpoints API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (TokenAuthentication). It accepts HTTP basic authentication (BasicAuthentication). By default, every request must be authenticated.

  • TokenAuthentication — Use the [Token authentication](section/Authentication/TokenAuthentication) scheme to authenticate to the InfluxDB API. In your API requests, send an Authorizat…
  • BasicAuthentication — Basic authentication scheme Use the HTTP Basic authentication scheme for InfluxDB /api/v2 API operations that support it: Syntax Authorization: Basic BASE64ENC…

Paths & Operations 17

Across 17 paths, the API surfaces 17 operations — 17 GET. Each is listed below with its method, path, parameters, and response codes.

System information endpoints 17
GET
/ping
Get the status of the instance
GetPing → 204
GET
/
List all top level routes
GetRoutes 1 param → 200
GET
/resources
List all known resources
GetResources 1 param → 200default
GET
/debug/pprof/all
Retrieve all runtime profiles
GetDebugPprofAllProfiles 2 params → 200default
GET
/debug/pprof/allocs
Retrieve the memory allocations runtime profile
GetDebugPprofAllocs 3 params → 200default
GET
/debug/pprof/block
Retrieve the block runtime profile
GetDebugPprofBlock 3 params → 200default
GET
/debug/pprof/cmdline
Retrieve the command line invocation
GetDebugPprofCmdline 1 param → 200default
GET
/debug/pprof/goroutine
Retrieve the goroutines runtime profile
GetDebugPprofGoroutine 3 params → 200default
GET
/debug/pprof/heap
Retrieve the heap runtime profile
GetDebugPprofHeap 4 params → 200default
GET
/debug/pprof/mutex
Retrieve the mutual exclusion (mutex) runtime profile
GetDebugPprofMutex 3 params → 200default
GET
/debug/pprof/profile
Retrieve the CPU runtime profile
GetDebugPprofProfile 2 params → 200default
GET
/debug/pprof/threadcreate
Retrieve the threadcreate runtime profile
GetDebugPprofThreadCreate 3 params → 200default
GET
/debug/pprof/trace
Retrieve the runtime execution trace
GetDebugPprofTrace 2 params → 200default
GET
/health
Retrieve the health of the instance
GetHealth 1 param → 200503default
GET
/metrics
Retrieve workload performance metrics
GetMetrics 1 param → 200default
GET
/ready
Get the readiness of an instance at startup
GetReady 1 param → 200default
GET
/config
Retrieve runtime configuration
GetConfig 1 param → 200401default

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Routes (18 properties), HealthCheck (6 properties), Error (4 properties), Ready (3 properties). Each schema is shown below with its type and property counts.

HealthCheck
object
6 properties 2 required
Routes
object
18 properties
Config
object
1 property
Ready
object
3 properties
Error
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdata-system-information-endpoints-api-openapi.yml Raw ↑

Other APIs InfluxData publishes across the network.

InfluxData Authorizations (API tokens) API
InfluxData Backup API
InfluxData Bucket Schemas API
InfluxData Buckets API
InfluxData Cells API
InfluxData Checks API
InfluxData Config API
InfluxData Dashboards API
InfluxData Data I/O endpoints API
InfluxData DBRPs API
InfluxData Debug API
InfluxData Delete API