diff options
Diffstat (limited to 'src/web/api/README.md')
| -rw-r--r-- | src/web/api/README.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/src/web/api/README.md b/src/web/api/README.md new file mode 100644 index 000000000..7ad1a7ad4 --- /dev/null +++ b/src/web/api/README.md @@ -0,0 +1,12 @@ +# API + +## Netdata agent REST API + +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). + +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)**. + +## Netdata cloud API + +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), +but has not yet been expanded for wider use. We intend to provide a properly documented API in the future. |