Yet another Python library for Grafana API
Project description
grafana_api
What is this library for?
Yet another Grafana API library for Python. Support both 2 and 3 Python versions.
Requirements
You need either 2nd or 3rd version of Python and only the requests
library installed.
Quick start
Install the pip package:
pip install -U grafana_api
And then connect to your Grafana API endpoint:
from grafana_api.grafana_face import GrafanaFace
grafana_api = GrafanaFace(auth='abcde....', host='api.my-grafana-host.com')
# Search dashboards based on tag
grafana_api.search.search_dashboards(tag='applications')
# Find a user by email
user = grafana_api.users.find_user('test@test.com')
# Add user to team 2
grafana_api.teams.add_team_member(2, user["id"])
# Create or update a dashboard
grafana_api.dashboard.update_dashboard(dashboard={'dashboard': {...}, 'folderId': 0, 'overwrite': True})
# Delete a dashboard by UID
grafana_api.dashboard.delete_dashboard(dashboard_uid='abcdefgh')
Status of REST API realization
Work on API implementation still in progress.
API | Status |
---|---|
Admin | + |
Alerting | - |
Annotations | + |
Authentication | +- |
Dashboard | + |
Dashboard Versions | - |
Dashboard Permissions | + |
Data Source | + |
Folder | + |
Folder Permissions | + |
Folder/Dashboard Search | +- |
Organisation | + |
Other | + |
Preferences | + |
Snapshot | - |
Teams | + |
User | + |
Issue tracker
Please report any bugs and enhancement ideas using the grafana_api
issue tracker:
https://github.com/m0nhawk/grafana_api/issues
Feel free to also ask questions on the tracker.
License
grafana_api
is licensed under the terms of the MIT License (see the file
LICENSE).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
grafana_api-0.8.1.tar.gz
(14.8 kB
view hashes)
Built Distribution
Close
Hashes for grafana_api-0.8.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b764b3c4db00170297b581ca2e62fe5b85f5d58205ed69a3ad6ec6d70aa9fe34 |
|
MD5 | 78528ab3f9190e0e9f5c4b4c1628648b |
|
BLAKE2b-256 | c603b86454bd4ba717340605645c2a874f0cf757edc3882efae661d58dd904d1 |