diff options
| author | Chris Akritidis <43294513+cakrit@users.noreply.github.com> | 2023-03-21 04:16:07 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-21 04:16:07 -0700 |
| commit | 491fb58cfcbfcb7fd9ea0d577dcb6b6ae1af2c77 (patch) | |
| tree | 6a636a0679969215d81240302d4fe7af1a18acbd /web | |
| parent | c0719b9f3a16091f4a48971bc16c0e63d0aab946 (diff) | |
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>
Diffstat (limited to 'web')
| -rw-r--r-- | web/api/README.md | 20 |
1 files changed, 8 insertions, 12 deletions
diff --git a/web/api/README.md b/web/api/README.md index 82a55eb250..237394a88c 100644 --- a/web/api/README.md +++ b/web/api/README.md @@ -1,16 +1,12 @@ -<!-- -title: "API" -custom_edit_url: "https://github.com/netdata/netdata/edit/master/web/api/README.md" -sidebar_label: "API" -learn_status: "Published" -learn_topic_type: "Tasks" -learn_rel_path: "Operations" ---> - # API -## Netdata REST 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/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/web/api/netdata-swagger.yaml)**. -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)**. +## Netdata cloud API -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. +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. |