public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[v10.4.x] [docs/sources/developers] Replace docs/reference shortcode with ref URIs (#88076)

Browse Source
This commit is contained in:
Jack Baldry
2024-06-03 13:26:36 +01:00
committed by GitHub
parent f4d7a1e68e
commit c40b6d1228
3 changed files with 27 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/developers/http_api/alerting.md
+13 -10
View File
@@ -15,6 +15,17 @@ labels:
- enterprise
- oss
title: Legacy Alerting API
refs:
admin-api:
- pattern: /docs/grafana/
destination: /docs/grafana/<GRAFANA_VERSION>/developers/http_api/admin/#pause-all-alerts
- pattern: /docs/grafana/
destination: /docs/grafana/<GRAFANA_VERSION>/developers/http_api/admin/#pause-all-alerts
grafana-alerting-alerts-documentation:
- pattern: /docs/grafana/
destination: /docs/grafana/<GRAFANA_VERSION>/alerting/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana/<GRAFANA_VERSION>/alerting/
---
# Legacy Alerting API
@@ -27,7 +38,7 @@ This topic is relevant for the [legacy dashboard alerts](/docs/grafana/v8.5/aler
If you are using Grafana Alerting, refer to [Alerting provisioning API]({{< relref "./alerting_provisioning" >}})
You can find Grafana Alerting API specification details [here](https://editor.swagger.io/?url=https://raw.githubusercontent.com/grafana/grafana/main/pkg/services/ngalert/api/tooling/post.json). Also, refer to [Grafana Alerting alerts documentation][] for details on how to create and manage new alerts.
You can find Grafana Alerting API specification details [here](https://editor.swagger.io/?url=https://raw.githubusercontent.com/grafana/grafana/main/pkg/services/ngalert/api/tooling/post.json). Also, refer to [Grafana Alerting alerts documentation](ref:grafana-alerting-alerts-documentation) for details on how to create and manage new alerts.
You can use the Alerting API to get information about legacy dashboard alerts and their states but this API cannot be used to modify the alert.
To create new alerts or modify them you need to update the dashboard JSON that contains the alerts.
@@ -173,12 +184,4 @@ Content-Type: application/json
## Pause all alerts
See [Admin API][].
{{% docs/reference %}}
[Admin API]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/developers/http_api/admin#pause-all-alerts"
[Admin API]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/developers/http_api/admin#pause-all-alerts"
[Grafana Alerting alerts documentation]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/alerting"
[Grafana Alerting alerts documentation]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/alerting"
{{% /docs/reference %}}
See [Admin API](ref:admin-api).