API de preferências - Amazon Managed Grafana
Obter as preferências atuais do usuárioAtualizar as preferências atuais do usuárioObter as preferências atuais da organizaçãoAtualizar as preferências atuais da organização

API de preferências

Use a API de preferências para trabalhar com as preferências do usuário no espaço de trabalho do Amazon Managed Grafana.

Chaves:

  • tema: os valores válidos são light, dark ou uma string vazia para usar o tema padrão.

  • homeDashboardId: o :id numérico de um dashboard marcado como favorito. O padrão é 0.

  • fuso horário: os valores válidos são utc, browser ou uma string vazia para usar o padrão.

A omissão de uma chave faz com que o valor atual seja substituído pelo valor padrão do sistema.

nota

Para usar uma API do Grafana com o espaço de trabalho do Amazon Managed Grafana, você deve ter um token válido da API do Grafana. Você inclui isso no campo Authorization na solicitação da API. Para obter informações sobre como criar um token para autenticar as chamadas de API, consulte Autenticação com tokens.

Obter as preferências atuais do usuário

GET /api/user/preferences

Exemplo de solicitação

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

Exemplo de resposta

HTTP/1.1 200
Content-Type: application/json

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

Atualizar as preferências atuais do usuário

PUT /api/user/preferences

Exemplo de solicitação

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

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

Exemplo de resposta

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

{"message":"Preferences updated"}

Obter as preferências atuais da organização

GET /api/org/preferences

Exemplo de solicitação

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

Exemplo de resposta

HTTP/1.1 200
Content-Type: application/json

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

Atualizar as preferências atuais da organização

PUT /api/org/preferences

Exemplo de solicitação

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

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

Exemplo de resposta

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

{"message":"Preferences updated"}