Update API (#14772)
* Update README.md * Add info on the cloud API * Update web/api/README.md Co-authored-by: Tasos Katsoulas <12612986+tkatsoulas@users.noreply.github.com> --------- Co-authored-by: Tasos Katsoulas <12612986+tkatsoulas@users.noreply.github.com>
Chris Akritidis committed
Mar 21, 2023 at 04:16 UTC
491fb58cfcbfcb7fd9ea0d577dcb6b6ae1af2c77
1 file changed
+8
-12
web/api/README.md
+8
-12
@@ -1,16 +1,12 @@
1
-<!--
2
-title: "API"
3
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/web/api/README.md"
4
-sidebar_label: "API"
5
-learn_status: "Published"
6
-learn_topic_type: "Tasks"
7
-learn_rel_path: "Operations"
8
--->
9
-
1
# API
2
12
-## Netdata REST API
3
+## Netdata agent REST 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/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/web/api/netdata-swagger.yaml)**.
8
14
-The complete documentation of the Netdata API is available as a Swagger API document [in our GitHub repository](https://raw.githubusercontent.com/netdata/netdata/master/web/api/netdata-swagger.yaml). You can view it online using the **[Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/netdata/netdata/master/web/api/netdata-swagger.yaml)**.
9
+## Netdata cloud API
10
16
-If your prefer it over the Swagger Editor, you can also use [Swagger UI](https://github.com/swagger-api/swagger-ui) by pointing at `web/api/netdata-swagger.yaml` in the Netdata source tree (or at https://raw.githubusercontent.com/netdata/netdata/master/web/api/netdata-swagger.yaml if you want to use the Swagger API definitions directly from our GitHub repository). This however does not provide all the information available.
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.