菜单
文档面包屑箭头 Grafana 文档面包屑箭头 开发者面包屑箭头 HTTP API面包屑箭头 认证 HTTP API
Enterprise 开源

认证 API

认证 HTTP API 用于管理 API 密钥。

注意

Grafana 建议使用服务账号而非 API 密钥。更多信息请参阅Grafana 服务账号 API 参考。

如果您运行的是 Grafana Enterprise，某些端点需要具备相关权限。更多信息请参阅基于角色的访问控制权限。

列出 API 密钥

警告

此端点已弃用。

GET /api/auth/keys

所需权限

请参阅简介中的说明。

操作范围
apikeys:readapikeys:*

请求示例:

http 
GET /api/auth/keys HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

查询参数

  • includeExpired: 布尔值。启用列出已过期密钥。可选。

响应示例:

http 
HTTP/1.1 200
Content-Type: application/json

[
  {
    "id": 3,
    "name": "API",
    "role": "Admin"
  },
  {
    "id": 1,
    "name": "TestAdmin",
    "role": "Admin",
    "expiration": "2019-06-26T10:52:03+03:00"
  }
]

创建 API 密钥

警告

此端点在 Grafana 11.3.0 中已废弃。

此端点已废弃，并已移至Grafana 服务账号 API。更多信息请参阅迁移到 Grafana 服务账号 API。

POST /api/auth/keys

响应示例:

http 
HTTP/1.1 410
Content-Type: application/json

{"message":"this endpoint has been removed, please use POST /api/serviceaccounts and POST /api/serviceaccounts/{id}/tokens instead"}

删除 API 密钥

警告

已弃用

DELETE /api/auth/keys/:id

所需权限

请参阅简介中的说明。

操作范围
apikeys:deleteapikeys:*

请求示例:

http 
DELETE /api/auth/keys/3 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

响应示例:

http 
HTTP/1.1 200
Content-Type: application/json

{"message":"API key deleted"}