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

Netdata nodes API

Everything related to monitored nodes

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

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

This API exposes 7 operations across 7 paths, and defines 6 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.

7 operations 7 paths 6 schemas 7 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
License
Resource Areas
1

Authentication & Security 3

Netdata nodes 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 7

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

nodes 7

Everything related to monitored nodes

GET
/api/v2/nodesdeprecated
Nodes Info v2
getNodes2 5 params → 200
GET
/api/v3/nodes
Nodes Info v3
getNodes3 5 params → 200
GET
/api/v1/infodeprecated
Node Info v1
getNodeInfo1 → 200503
GET
/api/v3/info
Retrieve detailed Netdata agent information across all nodes
info_v3 7 params → 200400500
GET
/api/v3/node_instances
Retrieve chart instances organized by node across the infrastructure
node_instances_v3 7 params → 200400500
GET
/api/v3/stream_path
Retrieve streaming topology path for nodes
stream_path 5 params → 200400500504
GET
/api/v2/node_instancesdeprecated
OBSOLETE: Get node instances hierarchy (use /api/v3/nodeinstances instead)
nodeInstances2 7 params → 200400

Schemas 6

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

nodeBasic
object
Basic information about a node.
5 properties 2 required
api
integer
The version of the API used.
info
object
22 properties
versions
object
Hashes that allow the caller to detect important database changes of Netdata Agents.
5 properties
agents
array
An array of Agent definitions consulted to compose this response.
nodeFull

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netdata-nodes-api-openapi.yml Raw ↑

Other APIs Netdata publishes across the network.

Netdata Agent API
Netdata alerts API
Netdata authentication API
Netdata badges API
Netdata charts API
Netdata claiming API
Netdata config API
Netdata contexts API
Netdata data API
Netdata dyncfg API
Netdata functions API
Netdata management API