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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Netdata

Netdata data API

Everything related to data queries

Documentation Provider Profile APIs.io OpenAPI GitHub

Netdata data API is one of 20 APIs that Netdata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include data. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 6 operations across 6 paths, and defines 20 schemas. It is described by OpenAPI 3.0.0, at version v1-rolling.

Requests are made against 3 base URLs: https://registry.my-netdata.io, http://registry.my-netdata.io, http://localhost:19999.

6 operations 6 paths 20 schemas 6 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1-rolling
Base URL
http://localhost:19999
Authentication
HTTP Bearer, HTTP Bearer, API Key
Contact
Netdata Agent API
License
GPL v3+
Resource Areas
1

Authentication & Security 3

Netdata data API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (aclkAuth). An API key is passed in the header as X-Forwarded-For (ipAcl).

  • bearerAuth — Bearer token authentication for API access when bearer protection is enabled. How to obtain a token: 1. Token must be obtained via /api/v3/bearergettoken endpo…
  • aclkAuth — ACLK-only authentication - these APIs are ONLY accessible via Netdata Cloud (ACLK). Access Requirements: - User must be authenticated via Netdata Cloud (SIGNED…
  • ipAcl — IP-based Access Control List restrictions (informational only). Configuration: APIs are subject to IP-based ACL restrictions configured in netdata.conf: conf […

Paths & Operations 6

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

data 6

Everything related to data queries

GET
/api/v2/datadeprecated
Data Query v2
dataQuery2 28 params → 200400500
GET
/api/v3/data
Data Query v3
dataQuery3 28 params → 200400500
GET
/api/v1/datadeprecated
Data Query v1 - Single node, single chart or context queries. without group-by.
dataQuery1 18 params → 200400404500
GET
/api/v1/allmetricsdeprecated
All Metrics v1 - Fetch latest value for all metrics
allMetrics1 10 params → 200400
GET
/api/v3/allmetrics
All Metrics v3 - Export all metrics in various formats - Latest API
allMetrics3 10 params → 200400500
GET
/api/v1/variabledeprecated
[DEPRECATED] Get a chart variable value
variable1 2 params → 200400404

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are jsonwrap1 (20 properties), jsonwrap2 (10 properties), jsonwrap2_sts_raw (6 properties), versions (5 properties). Each schema is shown below with its type and property counts.

data_csvjsonarray
array
The first inner array contains strings showing the labels of each column, each subsequent array contains the values for each point in time.
data_array
array
Data response in array format.
data_json2
object
3 properties
jsonwrap2
object
Data response with format=json2
10 properties
jsonwrap2_sts_raw
object
Statistical values when raw option is given.
6 properties
agents
array
An array of Agent definitions consulted to compose this response.
data_json_formats1
Depending on the format given to a data query, any of the following may be returned.
nodeWithDataStatistics
chart_variables
object
2 properties
data_txt
string
Data response in csv, tsv, tsv-excel, ssv, ssv-comma, markdown, html formats.
nodeBasic
object
Basic information about a node.
5 properties 2 required
data_json
object
Data response in json format.
2 properties
data_json_formats2
Depending on the format given to a data query, any of the following may be returned.
data_datatable
object
Data response in datatable / datasource formats (suitable for Google Charts).
2 properties
api
integer
The version of the API used.
jsonwrap2_sts
object
Statistical values
5 properties
jsonwrap2_items_count
object
Depending on the placement of this object, items may be nodes, contexts, instances, dimensions, label keys, label key-value pairs. Furthermore, if the whole ob…
4 properties
jsonwrap1
object
Response will contain the appropriate subtype, e.g. datajson depending on the requested format.
20 properties
versions
object
Hashes that allow the caller to detect important database changes of Netdata Agents.
5 properties
jsonwrap2_alerts_count
object
Counters about alert statuses. If this object is missing, it is assumed that all its members are zero.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netdata-data-api-openapi.yml Raw ↑

Other APIs Netdata publishes across the network.

Netdata Agent API
AE Profile APIs.io
Netdata alerts API
AE Profile APIs.io
Netdata authentication API
AE Profile APIs.io
Netdata badges API
AE Profile APIs.io
Netdata charts API
AE Profile APIs.io
Netdata claiming API
AE Profile APIs.io
Netdata config API
AE Profile APIs.io
Netdata contexts API
AE Profile APIs.io
Netdata dyncfg API
AE Profile APIs.io
Netdata functions API
AE Profile APIs.io
Netdata management API
AE Profile APIs.io
Netdata nodes API
AE Profile APIs.io
#data
← Back to N APIs
API Details
ID
netdata:netdata-data-api
Base URL
http://localhost:19999
Docs
https://learn.netdata.cloud/docs/developer-and-contributor-corner/rest-api
Provider
Netdata
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network