mirror of
https://github.com/grafana/grafana.git
synced 2025-07-30 03:02:44 +08:00
197 lines
3.5 KiB
Markdown
197 lines
3.5 KiB
Markdown
+++
|
|
aliases = ["/docs/grafana/latest/developers/http_api/preferences/", "/docs/grafana/latest/http_api/preferences/"]
|
|
description = "Grafana HTTP API"
|
|
keywords = ["grafana", "http", "documentation", "api", "preferences"]
|
|
title = "HTTP Preferences API "
|
|
+++
|
|
|
|
# User and Org Preferences API
|
|
|
|
Keys:
|
|
|
|
- **theme** - One of: `light`, `dark`, or an empty string for the default theme
|
|
- **homeDashboardId** - The numerical `:id` of a favorited dashboard, default: `0`
|
|
- **timezone** - One of: `utc`, `browser`, or an empty string for the default
|
|
|
|
Omitting a key will cause the current value to be replaced with the
|
|
system default value.
|
|
|
|
## Get Current User Prefs
|
|
|
|
`GET /api/user/preferences`
|
|
|
|
**Example Request**:
|
|
|
|
```http
|
|
GET /api/user/preferences HTTP/1.1
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
```
|
|
|
|
**Example Response**:
|
|
|
|
```http
|
|
HTTP/1.1 200
|
|
Content-Type: application/json
|
|
|
|
```
|
|
|
|
## Update Current User Prefs
|
|
|
|
`PUT /api/user/preferences`
|
|
|
|
**Example Request**:
|
|
|
|
```http
|
|
PUT /api/user/preferences HTTP/1.1
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
|
|
```
|
|
|
|
**Example Response**:
|
|
|
|
```http
|
|
HTTP/1.1 200
|
|
Content-Type: text/plain; charset=utf-8
|
|
|
|
```
|
|
|
|
## Patch Current User Prefs
|
|
|
|
Update one or more preferences without modifying the others.
|
|
|
|
`PATCH /api/user/preferences`
|
|
|
|
**Example Request**:
|
|
|
|
```http
|
|
PATCH /api/user/preferences HTTP/1.1
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
|
|
```
|
|
|
|
**Example Response**:
|
|
|
|
```http
|
|
HTTP/1.1 200
|
|
Content-Type: text/plain; charset=utf-8
|
|
|
|
```
|
|
|
|
## Get Current Org Prefs
|
|
|
|
`GET /api/org/preferences`
|
|
|
|
**Example Request**:
|
|
|
|
```http
|
|
GET /api/org/preferences HTTP/1.1
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
```
|
|
|
|
**Example Response**:
|
|
|
|
```http
|
|
HTTP/1.1 200
|
|
Content-Type: application/json
|
|
|
|
```
|
|
|
|
## Update Current Org Prefs
|
|
|
|
`PUT /api/org/preferences`
|
|
|
|
**Example Request**:
|
|
|
|
```http
|
|
PUT /api/org/preferences HTTP/1.1
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
|
|
```
|
|
|
|
**Example Response**:
|
|
|
|
```http
|
|
HTTP/1.1 200
|
|
Content-Type: text/plain; charset=utf-8
|
|
|
|
```
|
|
|
|
## Patch Current Org Prefs
|
|
|
|
Update one or more preferences without modifying the others.
|
|
|
|
`PATCH /api/org/preferences`
|
|
|
|
**Example Request**:
|
|
|
|
```http
|
|
PATCH /api/org/preferences HTTP/1.1
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
|
|
```
|
|
|
|
**Example Response**:
|
|
|
|
```http
|
|
HTTP/1.1 200
|
|
Content-Type: text/plain; charset=utf-8
|
|
|
|
```
|