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 weights API

Everything related to scoring / weighting metrics

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

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

This API exposes 4 operations across 4 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.

4 operations 4 paths 6 schemas 4 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 weights 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 4

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

weights 4

Everything related to scoring / weighting metrics

GET
/api/v2/weightsdeprecated
Score or weight all or some of the metrics, across all nodes, according to various algorithms.
weights2 23 params → 200400403404504
GET
/api/v3/weights
Score or weight all or some of the metrics, across all nodes, according to various algorithms.
weights3 23 params → 200400403404504
GET
/api/v1/weightsdeprecated
Score or weight all or some of the metrics of a single node, according to various algorithms.
weights1 12 params → 200400403404504
GET
/api/v1/metric_correlationsdeprecated
Analyze all the metrics to find their correlations - EOL
metricCorrelations1 11 params → 200400403404504

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are weights (15 properties), metric_correlations (15 properties), weighted_context (2 properties), weighted_chart (2 properties). Each schema is shown below with its type and property counts.

weighted_chart
object
2 properties
weighted_context
object
2 properties
metric_correlations
object
15 properties
weighted_dimension
number
weights2
object
weights
object
15 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netdata-weights-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