API delle preferenze

Usa l'API Preferences per lavorare con le preferenze degli utenti nell'area di lavoro Amazon Managed Grafana.

Chiavi:

• tema: i valori validi sono lightdark, o una stringa vuota per utilizzare il tema predefinito.

• homeDashboardId— Il valore numerico :id di un pannello di controllo preferito. Il valore predefinito è 0.

• timezone: i valori validi sono utcbrowser, oppure una stringa vuota per utilizzare l'impostazione predefinita.

L'omissione di una chiave fa sì che il valore corrente venga sostituito con il valore predefinito del sistema.

Nota

Per utilizzare un'API Grafana con il tuo spazio di lavoro Amazon Managed Grafana, devi disporre di un token API Grafana valido. Lo includi nel Authorization campo della richiesta API. Per informazioni su come creare un token per autenticare le chiamate API, consultaAutenticazione con token.

Ottieni le preferenze utente correnti

GET /api/user/preferences

Richiesta di esempio

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":""}

Aggiorna le preferenze utente correnti

PUT /api/user/preferences

Richiesta di esempio

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"}

Ottieni le preferenze attuali dell'organizzazione

GET /api/org/preferences

Richiesta di esempio

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":""}

Aggiorna le preferenze attuali dell'organizzazione

PUT /api/org/preferences

Richiesta di esempio

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"}