Using Grafana HTTP APIs
You can use Grafana HTTP APIs with Amazon Managed Grafana workspaces. The following sections list which Grafana APIs are supported.
To use a Grafana API with your Amazon Managed Grafana workspace, you must have a valid Grafana API key, which is also called an API token. To create an API key, use the following procedure. An API key is valid for a limited time that you specify when you create it, up to 30 days.
When you create an API key, you specify a role for the key. The role determines the level of administrative power that users of the key have.
The following tables show the permissions granted to the Admin, Editor, and Viewer roles. The first table shows general organizational permissions. In this table, Full means the ability to view, edit, add permissions, and delete permissions. The Explore column shows whether the role can use the Explore view. The Other permissions column shows whether the role has permissions for managing users, teams, plug-ins, and organizational settings.
Role | Dashboards | Playlists | Folders | Explore | Data sources | Other permissions |
---|---|---|---|---|---|---|
Viewer |
View | View | No | No | No | No |
Editor |
Full | Full | Full | Yes | No | No |
Admin |
Full | Full | Full | Yes | Full | Full |
The following table shows the additional dashboard- and folder-level permissions that you can set. These are different than the Admin, Editor, and Viewer roles.
Role | Dashboards | Folders | Change permissions |
---|---|---|---|
View |
View | View | No |
Edit |
Create, edit | View | No |
Admin |
Create, edit, delete | Create, edit, delete | Yes |
A more scoped permission with a lower permission level does not have effect if a more general rule with more permission exists. For example, if you give a user the organizational Editor role and then assign that user only the View permissions for a dashboard, the more restrictive View permission has no effect because the user has full Edit access because of their Editor role.
Topics
- Creating a Grafana API key to use with Grafana APIs in the workspace (Console)
- Creating an Amazon Managed Grafana workspace API key using AWS CLI
- Alerting API
- Alerting Notification Channels API
- Annotations API
- Authentication API
- Dashboard API
- Dashboard Permissions API
- Dashboard Versions API
- Data Source API
- Data Source Permissions API
- External Group Synchronization API
- Folder API
- Folder/Dashboard Search API
- Folder Permissions API
- Organization API
- Playlist API
- Preferences API
- Snapshot API
- Team API
- User API