Netdata alerts API
Everything related to alerts
Netdata alerts API is one of 20 APIs that Netdata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include alerts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 17 operations across 17 paths, and defines 37 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 alerts 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 17
Across 17 paths, the API surfaces 17 operations — 12 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Everything related to alerts
Schemas 37
The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are alarm_log_entry (31 properties), github_com_netdata_cloud-api-docs_cloud-alarm-processor-service_api.silencingRule (19 properties), alarm_variables (8 properties), github_com_netdata_cloud-alarm-processor-service_api.stuckRaisedAlert (8 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.