mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
43 lines
1.1 KiB
Markdown
43 lines
1.1 KiB
Markdown
|
----
|
||
|
|
page_title: HTTP API
|
||
|
|
page_description: Grafana HTTP API Reference
|
||
|
|
page_keywords: grafana, admin, http, api, documentation
|
||
|
|
---
|
||
|
|
|
||
|
|
# HTTP API Reference
|
||
|
|
|
||
|
|
The Grafana backend exposes an HTTP API, the same API is used by the frontend to do everything from saving
|
||
|
|
dashboards, creating users and updating data sources.
|
||
|
|
|
||
|
|
## Authorization
|
||
|
|
|
||
|
|
### Tokens
|
||
|
|
|
||
|
|
Currently you can authenticate via an `API Token` or via a `Session cookie` (acquired using regular login or oauth).
|
||
|
|
|
||
|
|
### Basic Auth
|
||
|
|
|
||
|
|
If basic auth is enabled (it is enabled by default) you can authenticate your HTTP request via
|
||
|
|
standard basic auth.
|
||
|
|
|
||
|
|
curl example:
|
||
|
|
```
|
||
|
|
?curl http://admin:admin@localhost:3000/api/org
|
||
|
|
{"id":1,"name":"Main Org."}
|
||
|
|
```
|
||
|
|
|
||
|
|
### Create API Token
|
||
|
|
|
||
|
|
Open the sidemenu and click the organization dropdown and select the `API Keys` option.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
You use the token in all requests in the `Authorization` header, like this:
|
||
|
|
|
||
|
|
**Example**:
|
||
|
|
|
||
|
|
GET http://your.grafana.com/api/dashboards/db/mydash HTTP/1.1
|
||
|
|
Accept: application/json
|
||
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
||
|
|
|
||
|
|
The `Authorization` header value should be `Bearer <your api key>`.
|