HTTP API 参考

Grafana 后端提供了一个 HTTP API，前端也使用相同的 API 来完成从保存仪表盘、创建用户到更新数据源的各项操作。

HTTP API 详情使用 OpenAPI v2 规范。

还有一个 OpenAPI v3 规范（由 v2 规范生成）。

用户可以通过 Swagger UI 编辑器（由 Grafana 服务器提供）浏览和尝试这两种规范，只需导航到 /swagger-ui。

验证 API 请求

您可以使用基本认证、服务账号令牌或会话 Cookie（通过常规登录或 OAuth 获取）来验证 HTTP API 请求。

基本认证

如果启用了基本认证（默认启用），您就可以通过标准基本认证来验证您的 HTTP 请求。基本认证也可以验证 LDAP 用户。

curl 示例

curl http://admin:admin@localhost:3000/api/org
{"id":1,"name":"Main Org."}

服务账号令牌

要创建服务账号令牌，请在左侧菜单中点击管理，然后点击用户与访问，再点击服务账号。有关如何使用服务账号令牌的更多信息，请参阅服务账号文档。

您可以在所有请求的 Authorization 头部中使用此令牌，如下所示：

示例:

GET http://your.grafana.com/api/dashboards/db/mydash HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Authorization 头部的值应为 Bearer <您的服务账号令牌>。

X-Grafana-Org-Id 头部

X-Grafana-Org-Id 是一个可选属性，用于指定应用该操作的组织。如果未设置此属性，创建的密钥将属于当前上下文组织。在所有请求中（除了管理员相关请求）都使用此头部。

示例请求:

GET /api/org/ HTTP/1.1
Accept: application/json
Content-Type: application/json
X-Grafana-Org-Id: 2
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk