api-tokens.md 1.1 KB

API Tokens

Overview

Every single user can get access to the Netdata resource programmatically. It is done through the API Token, also called Bearer Token. This token is used for authentication and authorization, it can be issued in the Netdata UI under the user Settings:

image

The API Tokens are not going to expire and can be limited to a few scopes:

  • scope:all

this token is given the same level of action as the user has, the use-case for it is Netdata terraform provider

  • scope:agent-ui

this token is mainly used by the local Netdata Agent accessing the Cloud UI

  • scope:grafana-plugin

this token is used for the Netdata Grafana plugin to access Netdata charts

Currently, Netdata Cloud is not exposing the stable API.

Example usage

  • get the Netdata Cloud space list

    curl -H 'Accept: application/json' -H "Authorization: Bearer <token>" https://app.netdata.cloud/api/v2/spaces