feat: add netdata cloud api-tokens docs (#17225)
* feat: add netdata cloud api-tokens docs * Update api-tokens.md * Update api-tokens.md * move to netadata-cloud/ * Update api-tokens.md --------- Co-authored-by: Fotis Voutsas <fotis@netdata.cloud>
Witold Duranek committed
Mar 22, 2024 at 12:39 UTC
1fdec630d94ac9ddf12982ce982ff9f783b26a9d
1 file changed
+34
docs/netdata-cloud/api-tokens.md
new
+34
@@ -0,0 +1,34 @@
1
+# API Tokens
2
+
3
+## Overview
4
+
5
+Every single user can get access to the Netdata resource programmatically. It is done through the API Token which
6
+can be also called as Bearer Token. This token is used for authentication and authorization, it can be issued
7
+in the Netdata UI under the user Settings:
8
+
9
+<img width="316" alt="image" src="https://github.com/netdata/netdata/assets/14999928/b0846076-afae-47ab-92df-c24967305ab9">
10
+
11
+The API Tokens are not going to expire and can be limited to a few scopes:
12
+
13
+* `scope:all`
14
+
15
+ this token is given the same level of action as the user has, the use-case for it is Netdata terraform provider
16
+
17
+* `scope:agent-ui`
18
+
19
+ this token is mainly used by the local Netdata agent accessing the Cloud UI
20
+
21
+* `scope:grafana-plugin`
22
+
23
+ this token is used for the [Netdata Grafana plugin](https://github.com/netdata/netdata-grafana-datasource-plugin/blob/master/README.md)
24
+ to access Netdata charts
25
+
26
+Currently, the Netdata Cloud is not exposing stable API.
27
+
28
+## Example usage
29
+
30
+* get the cloud space list
31
+
32
+```console
33
+$ curl -H 'Accept: application/json' -H "Authorization: Bearer <token>" https://app.netdata.cloud/api/v2/spaces
34
+```