IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Alerting docs: document HTTP API to create templates (#84055)

Browse Source
This commit is contained in:
Pepe Cano 2024-03-14 09:01:13 +01:00 committed by GitHub
parent b6a020148b
commit e1d9aa5a7b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/sources/alerting/set-up/provision-alerting-resources/export-alerting-resources/index.md
View File

@ -131,13 +131,13 @@ To export mute timings from the Grafana UI, complete the following steps.
You can use the [Alerting HTTP API][alerting_http_provisioning] to return existing alerting resources in JSON and import them to another Grafana instance using the same endpoint.
| Resource | URI | Methods |
| -------------------------------------------------------------- | ----------------------------------- | ---------------- |
| [Alert rules][alerting_http_alertrules] | /api/v1/provisioning/alert-rules | GET,POST,PUT,DEL |
| [Contact points][alerting_http_contactpoints] | /api/v1/provisioning/contact-points | GET,POST,PUT,DEL |
| [Notification policy tree][alerting_http_notificationpolicies] | /api/v1/provisioning/policies | GET,PUT,DEL |
| [Mute timings][alerting_http_mutetimings] | /api/v1/provisioning/mute-timings | GET,POST,PUT,DEL |
| [Templates][alerting_http_templates] | /api/v1/provisioning/templates | GET,PUT,DEL |
| Resource | URI |
| -------------------------------------------------------------- | ----------------------------------- |
| [Alert rules][alerting_http_alertrules] | /api/v1/provisioning/alert-rules |
| [Contact points][alerting_http_contactpoints] | /api/v1/provisioning/contact-points |
| [Notification policy tree][alerting_http_notificationpolicies] | /api/v1/provisioning/policies |
| [Mute timings][alerting_http_mutetimings] | /api/v1/provisioning/mute-timings |
| [Templates][alerting_http_templates] | /api/v1/provisioning/templates |
However, note the standard endpoints return a JSON format that is not compatible for provisioning through configuration files or Terraform, except the `/export` endpoints listed below.

14
docs/sources/shared/alerts/alerting_provisioning.md
View File

@ -157,12 +157,12 @@ For managing resources related to [data source-managed alerts]({{< relref "/docs
### Templates
| Method | URI | Name | Summary |
| ------ | ------------------------------------ | ----------------------------------------------- | ------------------------------------------ |
| DELETE | /api/v1/provisioning/templates/:name | [route delete template](#route-delete-template) | Delete a template. |
| GET | /api/v1/provisioning/templates/:name | [route get template](#route-get-template) | Get a notification template. |
| GET | /api/v1/provisioning/templates | [route get templates](#route-get-templates) | Get all notification templates. |
| PUT | /api/v1/provisioning/templates/:name | [route put template](#route-put-template) | Updates an existing notification template. |
| Method | URI | Name | Summary |
| ------ | ------------------------------------ | ----------------------------------------------- | ----------------------------------------- |
| DELETE | /api/v1/provisioning/templates/:name | [route delete template](#route-delete-template) | Delete a template. |
| GET | /api/v1/provisioning/templates/:name | [route get template](#route-get-template) | Get a notification template. |
| GET | /api/v1/provisioning/templates | [route get templates](#route-get-templates) | Get all notification templates. |
| PUT | /api/v1/provisioning/templates/:name | [route put template](#route-put-template) | Create or update a notification template. |
## Edit resources in the Grafana UI
@ -1200,7 +1200,7 @@ Status: Bad Request
[ValidationError](#validation-error)
### <span id="route-put-template"></span> Updates an existing notification template. (_RoutePutTemplate_)
### <span id="route-put-template"></span> Create or update a notification template. (_RoutePutTemplate_)
```
PUT /api/v1/provisioning/templates/:name