Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs Alert example is using non-public API #663

Open
j-svensmark opened this issue Jun 30, 2024 · 1 comment
Open

Docs Alert example is using non-public API #663

j-svensmark opened this issue Jun 30, 2024 · 1 comment

Comments

@j-svensmark
Copy link

In the docs there is an example of how to use the REST API to update an alert rule. The API used in the example (api/ruler/grafana/api/v1/rules) is apparently not intended for public use. Accordingly there doesn't appear to be any documentation of this API in Grafana docs. Example of the code in the docs:

    r = requests.delete(f"https://{server}/api/ruler/grafana/api/v1/rules/{folder}/{groupName}", headers=headers, verify=verify)

Would it be possible to update this example to use the alert provisioning API? https://grafana.com/docs/grafana/v10.4/developers/http_api/alerting_provisioning/

@j-svensmark
Copy link
Author

I noticed this issue after upgrading to Grafana 10, and seeing that the alerts we were uploading using Grafanalib were missing. It worked fine in Grafana 9.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant