8af271187c
* remove references to group sync * remove relfref and add new link * remove relfref * Update relfref * remove relrefs and add admonitions * fix URL * remove relrefs * replace relrefs * replace relrefs * replace relrefs * replace relrefs * replace relrefs * replace relrefs * replace relrefs * replace relrefs * run prettier --------- Co-authored-by: Irene Rodríguez <irene.rodriguez@grafana.com>
2.9 KiB
| aliases | canonical | description | keywords | labels | title | weight | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
/docs/grafana/latest/developers/http_api/ | Grafana HTTP API |
|
|
HTTP API | 100 |
HTTP API reference
The Grafana backend exposes an HTTP API, which is the same API that's used by the frontend to do everything from saving dashboards, creating users, and updating data sources.
HTTP API details are specified using OpenAPI v2.
There is also an OpenAPI v3 specification (generated by the v2 one).
Users can browser and try out both via the Swagger UI editor (served by the Grafana server) by navigating to /swagger-ui.
Authenticate API requests
{{< docs/shared lookup="developers/authentication.md" source="grafana" version="<GRAFANA_VERSION>" >}}
X-Grafana-Org-Id Header
X-Grafana-Org-Id is an optional property that specifies the organization to which the action is applied. If it is not set, the created key belongs to the current context org. Use this header in all requests except those regarding admin.
Example Request:
GET /api/org/ HTTP/1.1
Accept: application/json
Content-Type: application/json
X-Grafana-Org-Id: 2
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
HTTP APIs
- Admin API
- Alerting API (unstable)
- Alerting provisioning API
- Annotations API
- Correlations API
- Dashboard API
- Dashboard permissions API
- Dashboard versions API
- Data source API
- Folder API
- Folder permissions API
- Folder/Dashboard search API
- Library element API
- Organization API
- Other API
- Playlists API
- Preferences API
- Shared dashboards API
- Query history API
- Service account API
- Short URL API
- Snapshot API
- SSO settings API
- Team API
- User API
Deprecated HTTP APIs
Grafana Enterprise HTTP APIs
Grafana Enterprise includes all of the Grafana OSS APIs as well as the following APIs: