mirror of
https://github.com/grafana/grafana.git
synced 2025-08-02 06:32:15 +08:00
2ae63e70c0
Now returns uid in response to get notification channel by id. Adds GET/PUT/DELETE support for notification channel by uid, /api/alert-notifications/uid/:uid. Break apart alerting and alert notification http api docs in two pages and update documentation to make it up to date with current implementation. Fixes #16012
450 lines
9.9 KiB
Markdown
450 lines
9.9 KiB
Markdown
+++
|
||
title = "Admin HTTP API "
|
||
description = "Grafana Admin HTTP API"
|
||
keywords = ["grafana", "http", "documentation", "api", "admin"]
|
||
aliases = ["/http_api/admin/"]
|
||
type = "docs"
|
||
[menu.docs]
|
||
name = "Admin"
|
||
parent = "http_api"
|
||
+++
|
||
|
||
# Admin API
|
||
|
||
The Admin HTTP API does not currently work with an API Token. API Tokens are currently only linked to an organization and an organization role. They cannot be given
|
||
the permission of server admin, only users can be given that permission. So in order to use these API calls you will have to use Basic Auth and the Grafana user
|
||
must have the Grafana Admin permission. (The default admin user is called `admin` and has permission to use this API.)
|
||
|
||
## Settings
|
||
|
||
`GET /api/admin/settings`
|
||
|
||
Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
|
||
|
||
**Example Request**:
|
||
|
||
```bash
|
||
GET /api/admin/settings
|
||
Accept: application/json
|
||
Content-Type: application/json
|
||
```
|
||
|
||
**Example Response**:
|
||
|
||
```bash
|
||
HTTP/1.1 200
|
||
Content-Type: application/json
|
||
|
||
{
|
||
"DEFAULT": {
|
||
"app_mode":"production"
|
||
},
|
||
"analytics": {
|
||
"google_analytics_ua_id":"",
|
||
"reporting_enabled":"false"
|
||
},
|
||
"auth.anonymous":{
|
||
"enabled":"true",
|
||
"org_name":"Main Org.",
|
||
"org_role":"Viewer"
|
||
},
|
||
"auth.basic":{
|
||
"enabled":"false"
|
||
},
|
||
"auth.github":{
|
||
"allow_sign_up":"false",
|
||
"allowed_domains":"",
|
||
"allowed_organizations":"",
|
||
"api_url":"https://api.github.com/user",
|
||
"auth_url":"https://github.com/login/oauth/authorize",
|
||
"client_id":"some_id",
|
||
"client_secret":"************",
|
||
"enabled":"false",
|
||
"scopes":"user:email,read:org",
|
||
"team_ids":"",
|
||
"token_url":"https://github.com/login/oauth/access_token"
|
||
},
|
||
"auth.google":{
|
||
"allow_sign_up":"false","allowed_domains":"",
|
||
"api_url":"https://www.googleapis.com/oauth2/v1/userinfo",
|
||
"auth_url":"https://accounts.google.com/o/oauth2/auth",
|
||
"client_id":"some_client_id",
|
||
"client_secret":"************",
|
||
"enabled":"false",
|
||
"scopes":"https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email",
|
||
"token_url":"https://accounts.google.com/o/oauth2/token"
|
||
},
|
||
"auth.ldap":{
|
||
"config_file":"/etc/grafana/ldap.toml",
|
||
"enabled":"false"
|
||
},
|
||
"auth.proxy":{
|
||
"auto_sign_up":"true",
|
||
"enabled":"false",
|
||
"header_name":"X-WEBAUTH-USER",
|
||
"header_property":"username"
|
||
},
|
||
"dashboards.json":{
|
||
"enabled":"false",
|
||
"path":"/var/lib/grafana/dashboards"
|
||
},
|
||
"database":{
|
||
"host":"127.0.0.1:0000",
|
||
"name":"grafana",
|
||
"password":"************",
|
||
"path":"grafana.db",
|
||
"ssl_mode":"disable",
|
||
"type":"sqlite3",
|
||
"user":"root"
|
||
},
|
||
"emails":{
|
||
"templates_pattern":"emails/*.html",
|
||
"welcome_email_on_sign_up":"false"
|
||
},
|
||
"log":{
|
||
"buffer_len":"10000",
|
||
"level":"Info",
|
||
"mode":"file"
|
||
},
|
||
"log.console":{
|
||
"level":""
|
||
},
|
||
"log.file":{
|
||
"daily_rotate":"true",
|
||
"file_name":"",
|
||
"level":"",
|
||
"log_rotate":"true",
|
||
"max_days":"7",
|
||
"max_lines":"1000000",
|
||
"max_lines_shift":"28",
|
||
"max_size_shift":""
|
||
},
|
||
"paths":{
|
||
"data":"/tsdb/grafana",
|
||
"logs":"/logs/apps/grafana"},
|
||
"security":{
|
||
"admin_password":"************",
|
||
"admin_user":"admin",
|
||
"cookie_remember_name":"grafana_remember",
|
||
"cookie_username":"grafana_user",
|
||
"disable_gravatar":"false",
|
||
"login_remember_days":"7",
|
||
"secret_key":"************"
|
||
},
|
||
"server":{
|
||
"cert_file":"",
|
||
"cert_key":"",
|
||
"domain":"mygraf.com",
|
||
"enable_gzip":"false",
|
||
"enforce_domain":"false",
|
||
"http_addr":"127.0.0.1",
|
||
"http_port":"0000",
|
||
"protocol":"http",
|
||
"root_url":"%(protocol)s://%(domain)s:%(http_port)s/",
|
||
"router_logging":"true",
|
||
"data_proxy_logging":"true",
|
||
"static_root_path":"public"
|
||
},
|
||
"session":{
|
||
"cookie_name":"grafana_sess",
|
||
"cookie_secure":"false",
|
||
"gc_interval_time":"",
|
||
"provider":"file",
|
||
"provider_config":"sessions",
|
||
"session_life_time":"86400"
|
||
},
|
||
"smtp":{
|
||
"cert_file":"",
|
||
"enabled":"false",
|
||
"from_address":"admin@grafana.localhost",
|
||
"from_name":"Grafana",
|
||
"ehlo_identity":"dashboard.example.com",
|
||
"host":"localhost:25",
|
||
"key_file":"",
|
||
"password":"************",
|
||
"skip_verify":"false",
|
||
"user":""
|
||
},
|
||
"users":{
|
||
"allow_org_create":"true",
|
||
"allow_sign_up":"false",
|
||
"auto_assign_org":"true",
|
||
"auto_assign_org_role":"Viewer"
|
||
}
|
||
}
|
||
```
|
||
## Grafana Stats
|
||
|
||
`GET /api/admin/stats`
|
||
|
||
Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
|
||
|
||
**Example Request**:
|
||
|
||
```bash
|
||
GET /api/admin/stats
|
||
Accept: application/json
|
||
Content-Type: application/json
|
||
```
|
||
|
||
**Example Response**:
|
||
|
||
```json
|
||
HTTP/1.1 200
|
||
Content-Type: application/json
|
||
|
||
{
|
||
"users":2,
|
||
"orgs":1,
|
||
"dashboards":4,
|
||
"snapshots":2,
|
||
"tags":6,
|
||
"datasources":1,
|
||
"playlists":1,
|
||
"stars":2,
|
||
"alerts":2,
|
||
"activeUsers":1
|
||
}
|
||
```
|
||
|
||
## Global Users
|
||
|
||
`POST /api/admin/users`
|
||
|
||
Create new user. Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
|
||
|
||
**Example Request**:
|
||
```json
|
||
|
||
POST /api/admin/users HTTP/1.1
|
||
Accept: application/json
|
||
Content-Type: application/json
|
||
|
||
{
|
||
"name":"User",
|
||
"email":"user@graf.com",
|
||
"login":"user",
|
||
"password":"userpassword"
|
||
}
|
||
```
|
||
|
||
**Example Response**:
|
||
|
||
```json
|
||
HTTP/1.1 200
|
||
Content-Type: application/json
|
||
|
||
{"id":5,"message":"User created"}
|
||
```
|
||
|
||
## Password for User
|
||
|
||
`PUT /api/admin/users/:id/password`
|
||
|
||
Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
|
||
Change password for a specific user.
|
||
|
||
**Example Request**:
|
||
|
||
```json
|
||
PUT /api/admin/users/2/password HTTP/1.1
|
||
Accept: application/json
|
||
Content-Type: application/json
|
||
|
||
{"password":"userpassword"}
|
||
```
|
||
|
||
**Example Response**:
|
||
|
||
```json
|
||
HTTP/1.1 200
|
||
Content-Type: application/json
|
||
|
||
{"message": "User password updated"}
|
||
```
|
||
|
||
## Permissions
|
||
|
||
`PUT /api/admin/users/:id/permissions`
|
||
|
||
Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
|
||
|
||
**Example Request**:
|
||
|
||
```json
|
||
PUT /api/admin/users/2/permissions HTTP/1.1
|
||
Accept: application/json
|
||
Content-Type: application/json
|
||
|
||
{"isGrafanaAdmin": true}
|
||
```
|
||
|
||
**Example Response**:
|
||
|
||
```json
|
||
HTTP/1.1 200
|
||
Content-Type: application/json
|
||
|
||
{"message": "User permissions updated"}
|
||
```
|
||
|
||
## Delete global User
|
||
|
||
`DELETE /api/admin/users/:id`
|
||
|
||
Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
|
||
|
||
**Example Request**:
|
||
|
||
```json
|
||
DELETE /api/admin/users/2 HTTP/1.1
|
||
Accept: application/json
|
||
Content-Type: application/json
|
||
```
|
||
|
||
**Example Response**:
|
||
|
||
```json
|
||
HTTP/1.1 200
|
||
Content-Type: application/json
|
||
|
||
{"message": "User deleted"}
|
||
```
|
||
|
||
## Pause all alerts
|
||
|
||
`POST /api/admin/pause-all-alerts`
|
||
|
||
Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
|
||
|
||
**Example Request**:
|
||
|
||
```http
|
||
POST /api/admin/pause-all-alerts HTTP/1.1
|
||
Accept: application/json
|
||
Content-Type: application/json
|
||
|
||
```
|
||
|
||
JSON Body schema:
|
||
|
||
- **paused** – If true then all alerts are to be paused, false unpauses all alerts.
|
||
|
||
**Example Response**:
|
||
|
||
```http
|
||
HTTP/1.1 200
|
||
Content-Type: application/json
|
||
|
||
```
|
||
|
||
## Auth tokens for User
|
||
|
||
`GET /api/admin/users/:id/auth-tokens`
|
||
|
||
Return a list of all auth tokens (devices) that the user currently have logged in from.
|
||
|
||
Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
|
||
|
||
**Example Request**:
|
||
|
||
```http
|
||
GET /api/admin/users/1/auth-tokens HTTP/1.1
|
||
Accept: application/json
|
||
Content-Type: application/json
|
||
```
|
||
|
||
**Example Response**:
|
||
|
||
```http
|
||
HTTP/1.1 200
|
||
Content-Type: application/json
|
||
|
||
```
|
||
|
||
## Revoke auth token for User
|
||
|
||
`POST /api/admin/users/:id/revoke-auth-token`
|
||
|
||
Revokes the given auth token (device) for the user. User of issued auth token (device) will no longer be logged in
|
||
and will be required to authenticate again upon next activity.
|
||
|
||
Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
|
||
|
||
**Example Request**:
|
||
|
||
```http
|
||
POST /api/admin/users/1/revoke-auth-token HTTP/1.1
|
||
Accept: application/json
|
||
Content-Type: application/json
|
||
|
||
```
|
||
|
||
**Example Response**:
|
||
|
||
```http
|
||
HTTP/1.1 200
|
||
Content-Type: application/json
|
||
|
||
```
|
||
|
||
## Logout User
|
||
|
||
`POST /api/admin/users/:id/logout`
|
||
|
||
Logout user revokes all auth tokens (devices) for the user. User of issued auth tokens (devices) will no longer be logged in
|
||
and will be required to authenticate again upon next activity.
|
||
|
||
Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
|
||
|
||
**Example Request**:
|
||
|
||
```http
|
||
POST /api/admin/users/1/logout HTTP/1.1
|
||
Accept: application/json
|
||
Content-Type: application/json
|
||
```
|
||
|
||
**Example Response**:
|
||
|
||
```http
|
||
HTTP/1.1 200
|
||
Content-Type: application/json
|
||
|
||
```
|