;开发人员;HTTP API;API教程:为组织创建API令牌和仪表板

为组织创建API令牌和仪表板

使用Grafana API来设置新的Grafana组织,或者向现有组织添加动态生成的仪表板。

身份验证

有两种访问API的身份验证方法:

  • 基本身份验证:Grafana Admin用户可以通过基本身份验证访问Grafana API的某些部分。
  • API令牌:所有组织操作都通过API令牌访问。API令牌与组织相关联。它可以用于创建特定于该组织的仪表板和其他组件。

如何创建一个新的组织和一个API令牌

任务是创建一个新的组织,然后添加一个其他用户可以使用的令牌。在下面使用基本身份验证的示例中,用户为管理密码是管理

  1. 创建组织.下面是一个使用curl的例子:

    curl -X POST -H "Content-Type: application/json" -d '{"name":"apiorg"}' http://admin:admin@localhost:3000/api/orgs

    这应该返回一个响应:{“消息”:“组织”,“orgId”:6}.使用orgId进行下一步操作。

  2. 可选的步骤。如果org是之前创建的,并且/或步骤3失败,则先执行将您的Admin用户添加到org

    curl -X POST -H "Content-Type: application/json" -d '{"loginOrEmail":"admin", "role": "admin"}' http://admin:admin@localhost:3000/api/orgs//users
  3. 将Admin用户的org上下文切换到新的org

    curl -X POST http://admin:admin@localhost:3000/api/user/using/<新org>的id
  4. 创建API令牌

    curl -X POST -H "Content-Type: application/json" -d '{"name":"apikeycurl", "role": "Admin"}' http://admin:admin@localhost:3000/api/auth/keys . xml

    这应该返回一个响应:{" name ": " apikeycurl”,“关键”:“eyJrIjoiR0ZXZmt1UFc0OEpIOGN5RWdUalBJTllUTk83VlhtVGwiLCJuIjoiYXBpa2V5Y3VybCIsImlkIjo2fQ = = "}

    将这里返回的密钥保存在密码管理器中,因为将来不可能再次获取它。

如何添加仪表盘

使用在上一步中创建的令牌,您可以创建仪表板或执行其他操作,而不必切换组织。

  1. 添加仪表板使用键(也称为承载令牌):
curl -X POST——insecure -H "授权:持有者eyJrIjoiR0ZXZmt1UFc0OEpIOGN5RWdUalBJTllUTk83VlhtVGwiLCJuIjoiYXBpa2V5Y3VybCIsImlkIjo2fQ==" -H "内容-类型:application/json" -d '{"dashboard": {"id": null, "title": "Production Overview", "tags": ["templated"], "timezone": "browser", "rows": [{}], "schemaVersion": 6, "version": 0}, "overwrite": false}' http://localhost:3000/api/dashboards/db

注意:如果您使用Grafana UI中的“共享>导出”菜单导出一个仪表板供外部共享,则无法导入该仪表板。相反,点击查看JSON并将其保存到文件中,或者通过API获取JSON输出。