API de préférences

Utilisez l'API Preferences pour gérer les préférences des utilisateurs dans l'espace de travail Amazon Managed Grafana.

Clés :

• theme — Les valeurs valides sont lightdark, ou une chaîne vide pour utiliser le thème par défaut.

• homeDashboardId— Le chiffre :id d'un tableau de bord favori. La valeur par défaut est 0.

• timezone — Les valeurs valides sont utcbrowser, ou une chaîne vide pour utiliser la valeur par défaut.

L'omission d'une clé entraîne le remplacement de la valeur actuelle par la valeur par défaut du système.

Note

Pour utiliser une API Grafana avec votre espace de travail Amazon Managed Grafana, vous devez disposer d'un jeton d'API Grafana valide. Vous l'incluez dans le Authorization champ de la demande d'API. Pour plus d'informations sur la création d'un jeton pour authentifier vos appels d'API, consultezAuthentifiez-vous avec des jetons.

Obtenir les préférences actuelles de l'utilisateur

GET /api/user/preferences

Exemple de demande

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

Exemple de réponse

HTTP/1.1 200
Content-Type: application/json

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

Mettre à jour les préférences utilisateur actuelles

PUT /api/user/preferences

Exemple de demande

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

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

Exemple de réponse

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

{"message":"Preferences updated"}

Obtenir les préférences actuelles de l'organisation

GET /api/org/preferences

Exemple de demande

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

Exemple de réponse

HTTP/1.1 200
Content-Type: application/json

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

Mettre à jour les préférences actuelles de l'organisation

PUT /api/org/preferences

Exemple de demande

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

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

Exemple de réponse

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

{"message":"Preferences updated"}