summaryrefslogtreecommitdiffstats
path: root/web/api/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'web/api/README.md')
-rw-r--r--web/api/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/web/api/README.md b/web/api/README.md
new file mode 100644
index 0000000..1cc3439
--- /dev/null
+++ b/web/api/README.md
@@ -0,0 +1,14 @@
+<!--
+title: "API"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/README.md
+-->
+
+# API
+
+## Netdata REST API
+
+The complete documentation of the Netdata API is available at the **[Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/netdata/netdata/master/web/api/netdata-swagger.yaml)**.
+
+If your prefer it over the Swagger Editor, you can also use **[Swagger UI](https://registry.my-netdata.io/swagger/#!/default/get_data)**. This however does not provide all the information available.
+
+[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fweb%2Fapi%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)