diff options
Diffstat (limited to 'web/api/README.md')
-rw-r--r-- | web/api/README.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/web/api/README.md b/web/api/README.md new file mode 100644 index 0000000..fc520a0 --- /dev/null +++ b/web/api/README.md @@ -0,0 +1,12 @@ +<!-- +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 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)**. + +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. |