設定 API

設定 API を使用して、Amazon Managed Grafana ワークスペースのユーザー設定を操作します。

キー：

• テーマ — 有効な値はlight、デフォルトのテーマを使用する 、dark、または空の文字列です。

• homeDashboardId— お気に入りダッシュボード:idの数値。デフォルトは 0 です。

• timezone — 有効な値はutc、、browser、またはデフォルトを使用する空の文字列です。

キーを省略すると、現在の値がシステムのデフォルト値に置き換えられます。

注記

Amazon Managed Grafana ワークスペースで Grafana API を使用するには、有効な Grafana API トークンが必要です。これは API リクエストの Authorizationフィールドに含めます。API コールを認証するトークンを作成する方法については、「」を参照してくださいトークンによる認証。

現在のユーザー設定を取得する

GET /api/user/preferences

リクエストの例

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

レスポンスの例

HTTP/1.1 200
Content-Type: application/json

{"theme":"","homeDashboardId":0,"timezone":""}

現在のユーザー設定を更新する

PUT /api/user/preferences

リクエストの例

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

{
  "theme": "",
  "homeDashboardId":0,
  "timezone":"utc"
}

レスポンスの例

HTTP/1.1 200
Content-Type: text/plain; charset=utf-8

{"message":"Preferences updated"}

現在の組織設定を取得する

GET /api/org/preferences

リクエストの例

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

レスポンスの例

HTTP/1.1 200
Content-Type: application/json

{"theme":"","homeDashboardId":0,"timezone":""}

現在の組織設定を更新する

PUT /api/org/preferences

リクエストの例

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

{
  "theme": "",
  "homeDashboardId":0,
  "timezone":"utc"
}

レスポンスの例

HTTP/1.1 200
Content-Type: text/plain; charset=utf-8

{"message":"Preferences updated"}