Preferences API - Amazon Managed Grafana

Preferences API

Use the Preferences API to work with user preferences in the Amazon Managed Grafana workspace.

Keys:

  • theme— Valid values are light, dark, or an empty string to use the default theme.

  • homeDashboardId— The numerical :id of a favorited dashboard. The default is 0.

  • timezone— Valid values are utc, browser, or an empty string to use the default.

Omitting a key causes the current value to be replaced with the system default value.

Note

To use a Grafana API with your Amazon Managed Grafana workspace, you must have a valid Grafana API key. You include this key in the Authorization field in the API request. For information about how to create a Grafana API key, see Using Grafana HTTP APIs.

Get current user preferences

GET /api/user/preferences

Example request

GET /api/user/preferences HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Example response

HTTP/1.1 200 Content-Type: application/json {"theme":"","homeDashboardId":0,"timezone":""}

Update current user preferences

PUT /api/user/preferences

Example request

PUT /api/user/preferences HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk { "theme": "", "homeDashboardId":0, "timezone":"utc" }

Example response

HTTP/1.1 200 Content-Type: text/plain; charset=utf-8 {"message":"Preferences updated"}

Get current org preferences

GET /api/org/preferences

Example request

GET /api/org/preferences HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Example response

HTTP/1.1 200 Content-Type: application/json {"theme":"","homeDashboardId":0,"timezone":""}

Update current org preferences

PUT /api/org/preferences

Example request

PUT /api/org/preferences HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk { "theme": "", "homeDashboardId":0, "timezone":"utc" }

Example response

HTTP/1.1 200 Content-Type: text/plain; charset=utf-8 {"message":"Preferences updated"}