Update README.md (#21027)
Kanela committed
Sep 22, 2025 at 13:32 UTC
4eb9a5382e8b8d3e341f897d2bbfdd6867e591cd
1 file changed
+15
-5
src/web/api/README.md
+15
-5
@@ -1,12 +1,22 @@
1
-# API
1
+# Netdata API's
2
3
-## Netdata Agent REST API
3
+## Agent API
4
5
The complete documentation of the Netdata Agent's REST API is documented in the OpenAPI format [in our GitHub repository](https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml).
6
7
You can explore it using the **[Swagger UI](https://learn.netdata.cloud/api)**, or the **[Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/netdata/netdata/master/src/web/api/netdata-swagger.yaml)**.
8
9
-## Netdata Cloud API
9
+## Cloud API
10
11
-A very basic Netdata Cloud REST API supports the [Grafana data source plugin](https://github.com/netdata/netdata-grafana-datasource-plugin/blob/master/README.md),
12
-but has not yet been expanded for wider use. We intend to provide a properly documented API in the future.
11
+Netdata Cloud offers a public REST API for programmatic access to Cloud resources, spaces, war rooms, and nodes.
12
+
13
+You can explore the API directly via our live API documentation:
14
+
15
+- **[Open Cloud API Documentation](https://app.netdata.cloud/api/docs/)**
16
+
17
+:::tip
18
+
19
+This page redirects you to the live API explorer, which is always up-to-date.
20
+Use this to discover endpoints, payloads, and try requests directly in the browser.
21
+
22
+:::