Netdata dyncfg API
The dyncfg API from Netdata — 1 operation(s) for dyncfg.
Netdata dyncfg API is one of 20 APIs that Netdata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include dyncfg. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 2 operations across 1 path, and defines 5 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Netdata dyncfg 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 2
Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are config_entity (14 properties), config_attention (5 properties), config_tree (3 properties), config_default_response (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Netdata 12
Other APIs Netdata publishes across the network.