API de preferencias - Amazon Managed Grafana

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

API de preferencias

Use la API de preferencias para trabajar con las preferencias del usuario en el espacio de trabajo de Amazon Managed Grafana.

Claves:

  • theme: los valores válidos son light, dark o una cadena vacía para usar el tema predeterminado.

  • homeDashboardId: :id numérico de un panel marcado como favorito. El valor predeterminado es 0.

  • timezone: los valores válidos son utc, browser o una cadena vacía para usar el valor predeterminado.

Si se omite una clave, el valor actual se sustituye por el valor predeterminado del sistema.

nota

Para usar una API de Grafana con su espacio de trabajo de Amazon Managed Grafana, debe tener un token de API de Grafana que sea válido. Lo incluye en el campo Authorization de la solicitud de API. Para obtener información sobre cómo crear un token para autenticar sus llamadas a la API, consulte Autenticación con tokens.

Obtención de las preferencias actuales del usuario

GET /api/user/preferences

Ejemplo de solicitud

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

Ejemplo de respuesta

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

Actualización de las preferencias actuales del usuario

PUT /api/user/preferences

Ejemplo de solicitud

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

Ejemplo de respuesta

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

Obtención de las preferencias actuales de la organización

GET /api/org/preferences

Ejemplo de solicitud

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

Ejemplo de respuesta

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

Actualización de las preferencias actuales de la organización

PUT /api/org/preferences

Ejemplo de solicitud

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

Ejemplo de respuesta

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