Netdata contexts API
Everything related contexts - in new code, use this instead of charts
Netdata contexts API is one of 20 APIs that Netdata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include contexts. 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 7 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 contexts 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.
Everything related contexts - in new code, use this instead of charts
Schemas 7
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are context (10 properties), context_summary (6 properties), versions (5 properties), context2Basic (5 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.