Einstellungen-API

Verwenden Sie die Preferences-API, um mit Benutzereinstellungen im Amazon Managed Grafana-Workspace zu arbeiten.

Schlüssel:

• theme — Gültige Werte sind lightdark, oder eine leere Zeichenfolge, um das Standarddesign zu verwenden.

• homeDashboardId— Die Zahl :id eines bevorzugten Dashboards. Der Standardwert ist 0.

• Zeitzone — Gültige Werte sindutc, oder eine leere Zeichenfolgebrowser, um die Standardwerte zu verwenden.

Wenn Sie einen Schlüssel weglassen, wird der aktuelle Wert durch den Standardwert des Systems ersetzt.

Anmerkung

Um eine Grafana-API mit Ihrem Amazon Managed Grafana-Workspace verwenden zu können, benötigen Sie ein gültiges Grafana-API-Token. Sie fügen dies in das Authorization Feld in der API-Anfrage ein. Informationen zum Erstellen eines Tokens zur Authentifizierung Ihrer API-Aufrufe finden Sie unterAuthentifizieren Sie sich mit Tokens.

Aktuelle Benutzereinstellungen abrufen

GET /api/user/preferences

Beispielanforderung

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

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

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

Aktuelle Benutzereinstellungen aktualisieren

PUT /api/user/preferences

Beispielanforderung

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

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

Beispielantwort

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

{"message":"Preferences updated"}

Aktuelle Unternehmenseinstellungen abrufen

GET /api/org/preferences

Beispielanforderung

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

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

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

Aktualisiere die aktuellen Einstellungen der Organisation

PUT /api/org/preferences

Beispielanforderung

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

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

Beispielantwort

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

{"message":"Preferences updated"}