2024-02-12 17:27:18 +08:00
---
labels:
products:
- enterprise
- oss
title: 'Alerting Provisioning HTTP API '
---
2024-08-05 22:47:48 +08:00
The Alerting Provisioning HTTP API can be used to create, modify, and delete resources relevant to Grafana-managed alerts. This API is the one used by our [Grafana Terraform provider ](https://registry.terraform.io/providers/grafana/grafana/latest/docs ).
2024-02-12 17:27:18 +08:00
2024-08-05 22:47:48 +08:00
For more information on the differences between Grafana-managed and data source-managed alerts, refer to [Introduction to alert rules ](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/alerting/fundamentals/alert-rules/ ).
2024-02-12 17:27:18 +08:00
2024-08-05 22:47:48 +08:00
> If you are running Grafana Enterprise, you need to add specific permissions for some endpoints. For more information, refer to [Role-based access control permissions](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/administration/roles-and-permissions/access-control/custom-role-actions-scopes/).
2024-02-12 17:27:18 +08:00
2024-08-05 22:47:48 +08:00
## Grafana-managed endpoints
2024-02-12 17:27:18 +08:00
2025-03-10 18:33:30 +08:00
{{< admonition type = "note" > }}
In the Alerting provisioning HTTP API, the endpoints use a JSON format that differs from the format returned by the `export` endpoints.
The `export` endpoints allow you to export alerting resources in a JSON format suitable for [provisioning via files ](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/alerting/set-up/provision-alerting-resources/file-provisioning/ ). However, this format cannot be used to update resources via the HTTP API.
{{< / admonition > }}
2024-02-12 17:27:18 +08:00
### Alert rules
2025-06-17 16:40:57 +08:00
| Method | URI | Name | Summary |
| ------ | ---------------------------------------------------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------- |
| DELETE | /api/v1/provisioning/alert-rules/:uid | [route delete alert rule ](#route-delete-alert-rule ) | Delete a specific alert rule by UID. |
| GET | /api/v1/provisioning/alert-rules/:uid | [route get alert rule ](#route-get-alert-rule ) | Get a specific alert rule by UID. |
| POST | /api/v1/provisioning/alert-rules | [route post alert rule ](#route-post-alert-rule ) | Create a new alert rule. |
| PUT | /api/v1/provisioning/alert-rules/:uid | [route put alert rule ](#route-put-alert-rule ) | Update an existing alert rule. |
| GET | /api/v1/provisioning/alert-rules/:uid/export | [route get alert rule export ](#route-get-alert-rule-export ) | Export an alert rule in provisioning file format. |
| GET | /api/v1/provisioning/folder/:folderUid/rule-groups/:group | [route get alert rule group ](#route-get-alert-rule-group ) | Get a rule group. |
| PUT | /api/v1/provisioning/folder/:folderUid/rule-groups/:group | [route put alert rule group ](#route-put-alert-rule-group ) | Create or update a rule group. |
| GET | /api/v1/provisioning/folder/:folderUid/rule-groups/:group/export | [route get alert rule group export ](#route-get-alert-rule-group-export ) | Export an alert rule group in provisioning file format. |
| GET | /api/v1/provisioning/alert-rules | [route get alert rules ](#route-get-alert-rules ) | Get all the alert rules. |
| GET | /api/v1/provisioning/alert-rules/export | [route get alert rules export ](#route-get-alert-rules-export ) | Export all alert rules in provisioning file format. |
2024-02-12 17:27:18 +08:00
2024-08-05 22:47:48 +08:00
**Example request for new alert rule:**
```http
POST /api/v1/provisioning/alert-rules
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
2024-02-12 17:27:18 +08:00
{
"title": "TEST-API_1",
"ruleGroup": "API",
2024-08-05 22:47:48 +08:00
"folderUID": "SET_FOLDER_UID",
2024-02-12 17:27:18 +08:00
"noDataState": "OK",
"execErrState": "OK",
"for": "5m",
"orgId": 1,
"uid": "",
"condition": "B",
"annotations": {
"summary": "test_api_1"
},
"labels": {
"API": "test1"
},
"data": [
{
"refId": "A",
"queryType": "",
"relativeTimeRange": {
"from": 600,
"to": 0
},
2024-08-05 22:47:48 +08:00
"datasourceUid": "XXXXXXXXX-XXXXXXXXX-XXXXXXXXXX",
2024-02-12 17:27:18 +08:00
"model": {
"expr": "up",
"hide": false,
"intervalMs": 1000,
"maxDataPoints": 43200,
"refId": "A"
}
},
{
"refId": "B",
"queryType": "",
"relativeTimeRange": {
"from": 0,
"to": 0
},
"datasourceUid": "-100",
"model": {
"conditions": [
{
"evaluator": {
"params": [6],
"type": "gt"
},
"operator": {
"type": "and"
},
"query": {
"params": ["A"]
},
"reducer": {
"params": [],
"type": "last"
},
"type": "query"
}
],
"datasource": {
"type": "__expr__",
"uid": "-100"
},
"hide": false,
"intervalMs": 1000,
"maxDataPoints": 43200,
"refId": "B",
"type": "classic_conditions"
}
}
]
}
2024-08-05 22:47:48 +08:00
```
#### Example Response:
```http
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": 1,
"uid": "XXXXXXXXX",
"orgID": 1,
"folderUID": "SET_FOLDER_UID",
"ruleGroup": "API3",
"title": "TEST-API_1",
"condition": "B",
"data": [
{
"refId": "A",
"queryType": "",
"relativeTimeRange": {
"from": 600,
"to": 0
},
"datasourceUid": "XXXXXXXXX-XXXXXXXXX-XXXXXXXXXX",
"model": {
"expr": "up",
"hide": false,
"intervalMs": 1000,
"maxDataPoints": 43200,
"refId": "A"
}
},
{
"refId": "B",
"queryType": "",
"relativeTimeRange": {
"from": 0,
"to": 0
},
"datasourceUid": "-100",
"model": {
"conditions": [
{
"evaluator": {
"params": [
6
],
"type": "gt"
},
"operator": {
"type": "and"
},
"query": {
"params": [
"A"
]
},
"reducer": {
"params": [],
"type": "last"
},
"type": "query"
}
],
"datasource": {
"type": "__expr__",
"uid": "-100"
},
"hide": false,
"intervalMs": 1000,
"maxDataPoints": 43200,
"refId": "B",
"type": "classic_conditions"
}
}
],
"updated": "2024-08-02T13:19:32.609640048Z",
"noDataState": "OK",
"execErrState": "OK",
"for": "5m",
"annotations": {
"summary": "test_api_1"
},
"labels": {
"API": "test1"
},
"provenance": "api",
"isPaused": false,
"notification_settings": null,
"record": null
}
2024-02-12 17:27:18 +08:00
```
### Contact points
| Method | URI | Name | Summary |
| ------ | ------------------------------------------ | ----------------------------------------------------------------- | ------------------------------------------------------ |
| DELETE | /api/v1/provisioning/contact-points/:uid | [route delete contactpoints ](#route-delete-contactpoints ) | Delete a contact point. |
| GET | /api/v1/provisioning/contact-points | [route get contactpoints ](#route-get-contactpoints ) | Get all the contact points. |
| POST | /api/v1/provisioning/contact-points | [route post contactpoints ](#route-post-contactpoints ) | Create a contact point. |
| PUT | /api/v1/provisioning/contact-points/:uid | [route put contactpoint ](#route-put-contactpoint ) | Update an existing contact point. |
2024-02-27 23:22:24 +08:00
| GET | /api/v1/provisioning/contact-points/export | [route get contactpoints export ](#route-get-contactpoints-export ) | Export all contact points in provisioning file format. |
2024-02-12 17:27:18 +08:00
2024-08-05 22:47:48 +08:00
**Example Request for all the contact points:**
```http
GET /api/v1/provisioning/contact-points
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
**Example Response:**
```http
HTTP/1.1 200 OK
Content-Type: application/json
[
{
"uid": "",
"name": "email receiver",
"type": "email",
"settings": {
"addresses": "< example @ email . com > "
},
"disableResolveMessage": false
}
]
```
2024-02-12 17:27:18 +08:00
### Notification policies
| Method | URI | Name | Summary |
| ------ | ------------------------------------ | ------------------------------------------------------------- | ---------------------------------------------------------------- |
| DELETE | /api/v1/provisioning/policies | [route reset policy tree ](#route-reset-policy-tree ) | Clears the notification policy tree. |
| GET | /api/v1/provisioning/policies | [route get policy tree ](#route-get-policy-tree ) | Get the notification policy tree. |
| PUT | /api/v1/provisioning/policies | [route put policy tree ](#route-put-policy-tree ) | Sets the notification policy tree. |
2024-02-27 23:22:24 +08:00
| GET | /api/v1/provisioning/policies/export | [route get policy tree export ](#route-get-policy-tree-export ) | Export the notification policy tree in provisioning file format. |
2024-02-12 17:27:18 +08:00
2024-08-05 22:47:48 +08:00
**Example Request for exporting the notification policy tree in YAML format:**
```http
GET /api/v1/provisioning/policies/export?format=yaml
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
**Example Response:**
```http
HTTP/1.1 200 OK
Content-Type: text/yaml
apiVersion: 1
policies:
- orgId: 1
receiver: My Contact Email Point
group_by:
- grafana_folder
- alertname
routes:
- receiver: My Contact Email Point
object_matchers:
- - monitor
- =
- testdata
mute_time_intervals:
- weekends
```
2024-11-22 20:40:20 +08:00
### Notification template groups
2024-02-12 17:27:18 +08:00
2024-11-22 20:40:20 +08:00
Template groups enable you to define multiple notification templates (`{{ define "" }}`) within a single group. They can be managed from the Grafana Alerting UI.
2024-02-12 17:27:18 +08:00
2024-11-22 20:40:20 +08:00
| Method | URI | Name | Summary |
| ------ | ------------------------------------ | ----------------------------------------------- | ----------------------------------------------- |
| DELETE | /api/v1/provisioning/templates/:name | [route delete template ](#route-delete-template ) | Delete a notification template group. |
| GET | /api/v1/provisioning/templates/:name | [route get template ](#route-get-template ) | Get a notification template group. |
| GET | /api/v1/provisioning/templates | [route get template ](#route-get-templates ) | Get all notification template groups. |
| PUT | /api/v1/provisioning/templates/:name | [route put template ](#route-put-template ) | Create or update a notification template group. |
**Example Request for all notification template groups:**
2024-08-05 22:47:48 +08:00
```http
2024-11-22 20:40:20 +08:00
GET /api/v1/provisioning/templates
2024-08-05 22:47:48 +08:00
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
**Example Response:**
```http
HTTP/1.1 200 OK
Content-Type: application/json
[
{
2024-11-22 20:40:20 +08:00
"name": "custom_email.message",
"template": "{{ define \"custom_email.message\" }}\n Custom alert!\n{{ end }}",
"provenance": "file"
},
{
"name": "custom_email.subject",
"template": "{{ define \"custom_email.subject\" }}\n{{ len .Alerts.Firing }} firing alert(s), {{ len .Alerts.Resolved }} resolved alert(s)\n{{ end }}",
2024-08-05 22:47:48 +08:00
"provenance": "file"
}
]
```
2024-11-22 20:40:20 +08:00
### Mute timings
2024-02-12 17:27:18 +08:00
2024-11-22 20:40:20 +08:00
| Method | URI | Name | Summary |
| ------ | ---------------------------------------------- | --------------------------------------------------------------- | ---------------------------------------------------- |
| DELETE | /api/v1/provisioning/mute-timings/:name | [route delete mute timing ](#route-delete-mute-timing ) | Delete a mute timing. |
| GET | /api/v1/provisioning/mute-timings/:name | [route get mute timing ](#route-get-mute-timing ) | Get a mute timing. |
| GET | /api/v1/provisioning/mute-timings | [route get mute timings ](#route-get-mute-timings ) | Get all the mute timings. |
| POST | /api/v1/provisioning/mute-timings | [route post mute timing ](#route-post-mute-timing ) | Create a new mute timing. |
| PUT | /api/v1/provisioning/mute-timings/:name | [route put mute timing ](#route-put-mute-timing ) | Replace an existing mute timing. |
| GET | /api/v1/provisioning/mute-timings/export | [route get mute timings export ](#route-get-mute-timings-export ) | Export all mute timings in provisioning file format. |
| GET | /api/v1/provisioning/mute-timings/:name/export | [route get mute timing export ](#route-get-mute-timing-export ) | Export a mute timing in provisioning file format. |
2024-02-12 17:27:18 +08:00
2024-11-22 20:40:20 +08:00
**Example Request for all mute timings:**
2024-08-05 22:47:48 +08:00
```http
2024-11-22 20:40:20 +08:00
GET /api/v1/provisioning/mute-timings
2024-08-05 22:47:48 +08:00
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
**Example Response:**
```http
HTTP/1.1 200 OK
Content-Type: application/json
[
{
2024-11-22 20:40:20 +08:00
"name": "weekends",
"time_intervals": [
{
"weekdays": [
"saturday",
"sunday"
]
}
],
"version": "",
2024-08-05 22:47:48 +08:00
"provenance": "file"
}
]
```
### Edit resources in the Grafana UI
2024-02-12 17:27:18 +08:00
2025-03-10 18:33:30 +08:00
By default, you cannot edit API-provisioned alerting resources in Grafana.
To enable editing these resources in the Grafana UI, add the ** `X-Disable-Provenance: true` ** header to the following API requests:
2024-02-12 17:27:18 +08:00
2025-05-28 17:11:56 +08:00
- [`PUT /api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}` ](#route-put-alert-rule-group ): This action also sets the provenance for the rule group and all its alert rules.
- [`POST /api/v1/provisioning/alert-rules` ](#route-post-alert-rule ): The provenance of the new alert rule must match the provenance value configured for its rule group.
- [`POST /api/v1/provisioning/contact-points` ](##route-post-contactpoints )
- [`POST /api/v1/provisioning/mute-timings` ](#route-post-mute-timing )
- [`PUT /api/v1/provisioning/templates/{name}` ](#route-put-template )
- [`PUT /api/v1/provisioning/policies` ](#route-put-policy-tree )
2025-03-10 18:33:30 +08:00
To reset the notification policy tree to the default and unlock it for editing in the Grafana UI, use:
2024-02-12 17:27:18 +08:00
2025-05-28 17:11:56 +08:00
- [`DELETE /api/v1/provisioning/policies` ](#route-reset-policy-tree )
2024-02-12 17:27:18 +08:00
2024-08-05 22:47:48 +08:00
## Data source-managed resources
2024-12-09 16:43:19 +08:00
The Alerting Provisioning HTTP API can only be used to manage Grafana-managed alert resources. To manage resources related to [data source-managed alerts ](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/alerting/alerting-rules/create-data-source-managed-rule/ ), consider the following tools:
2024-08-05 22:47:48 +08:00
2025-06-19 23:02:07 +08:00
- [mimirtool ](https://grafana.com/docs/mimir/<MIMIR_VERSION>/manage/tools/mimirtool/ ): to interact with the Mimir alertmanager and ruler configuration.
2024-08-05 22:47:48 +08:00
- [cortex-tools ](https://github.com/grafana/cortex-tools#cortextool ): to interact with the Cortex alertmanager and ruler configuration.
2025-06-19 23:02:07 +08:00
- [lokitool ](https://grafana.com/docs/loki/<LOKI_VERSION>/alert/#lokitool ): to configure the Loki Ruler.
2024-08-05 22:47:48 +08:00
2024-08-20 06:03:07 +08:00
Alternatively, the [Grafana Alerting API ](https://editor.swagger.io/?url=https://raw.githubusercontent.com/grafana/grafana/main/pkg/services/ngalert/api/tooling/post.json ) can be used to access data from data source-managed alerts. This API is primarily intended for internal usage, with the exception of the `/api/v1/provisioning/` endpoints. It's important to note that internal APIs may undergo changes without prior notice and are not officially supported for user consumption.
For Prometheus, `amtool` can also be used to interact with the [AlertManager API ](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/prometheus/alertmanager/main/api/v2/openapi.yaml#/ ).
2024-02-12 17:27:18 +08:00
## Paths
### <span id="route-delete-alert-rule"></span> Delete a specific alert rule by UID. (_RouteDeleteAlertRule_)
```
DELETE /api/v1/provisioning/alert-rules/:uid
```
#### Parameters
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| ---------------------------- | ------ | ------ | ------- | :------: | ------- | --------------------------------------------------------- |
| `UID` | path | string | string | ✓ | | Alert rule UID |
| `X-Disable-Provenance: true` | header | string | string | | | Allows editing of provisioned resources in the Grafana UI |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
#### All responses
| Code | Status | Description | Has headers | Schema |
| ----------------------------------- | ---------- | ---------------------------------------- | :---------: | --------------------------------------------- |
| [204 ](#route-delete-alert-rule-204 ) | No Content | The alert rule was deleted successfully. | | [schema ](#route-delete-alert-rule-204-schema ) |
#### Responses
##### <span id="route-delete-alert-rule-204"></span> 204 - The alert rule was deleted successfully.
Status: No Content
###### <span id="route-delete-alert-rule-204-schema"></span> Schema
### <span id="route-delete-contactpoints"></span> Delete a contact point. (_RouteDeleteContactpoints_)
```
DELETE /api/v1/provisioning/contact-points/:uid
```
#### Parameters
2025-03-10 18:33:30 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| ----- | ------ | ------ | ------- | :------: | ------- | ------------------------------------------ |
| `UID` | path | string | string | ✓ | | UID is the contact point unique identifier |
2024-02-12 17:27:18 +08:00
#### All responses
| Code | Status | Description | Has headers | Schema |
| -------------------------------------- | ---------- | ------------------------------------------- | :---------: | ------------------------------------------------ |
| [204 ](#route-delete-contactpoints-204 ) | No Content | The contact point was deleted successfully. | | [schema ](#route-delete-contactpoints-204-schema ) |
#### Responses
##### <span id="route-delete-contactpoints-204"></span> 204 - The contact point was deleted successfully.
Status: No Content
###### <span id="route-delete-contactpoints-204-schema"></span> Schema
### <span id="route-delete-mute-timing"></span> Delete a mute timing. (_RouteDeleteMuteTiming_)
```
DELETE /api/v1/provisioning/mute-timings/:name
```
#### Parameters
2025-03-10 18:33:30 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| --------- | ------ | ------ | ------- | :------: | ------- | ------------------------------------------------------------------------------------------------------------- |
| `name` | path | string | string | ✓ | | Mute timing name |
| `version` | query | string | string | | | Current version of the resource. Used for optimistic concurrency validation. Keep empty to bypass validation. |
2024-02-12 17:27:18 +08:00
#### All responses
| Code | Status | Description | Has headers | Schema |
| ------------------------------------ | ---------- | ----------------------------------------- | :---------: | ---------------------------------------------- |
| [204 ](#route-delete-mute-timing-204 ) | No Content | The mute timing was deleted successfully. | | [schema ](#route-delete-mute-timing-204-schema ) |
2024-08-09 23:40:07 +08:00
| [409 ](#route-delete-mute-timing-409 ) | Conflict | GenericPublicError | | [schema ](#route-delete-mute-timing-409-schema ) |
2024-02-12 17:27:18 +08:00
#### Responses
##### <span id="route-delete-mute-timing-204"></span> 204 - The mute timing was deleted successfully.
Status: No Content
###### <span id="route-delete-mute-timing-204-schema"></span> Schema
2024-08-09 23:40:07 +08:00
##### <span id="route-delete-mute-timing-409"></span> 409 - Conflict
Status: Conflict
###### <span id="route-delete-mute-timing-409-schema"></span> Schema
[GenericPublicError ](#generic-public-error )
2024-11-22 20:40:20 +08:00
### <span id="route-delete-template"></span> Delete a notification template group. (_RouteDeleteTemplate_)
2024-02-12 17:27:18 +08:00
```
DELETE /api/v1/provisioning/templates/:name
```
#### Parameters
2025-03-10 18:33:30 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| --------- | ------ | ------ | ------- | :------: | ------- | ------------------------------------------------------------------------------------------------------------- |
| `name` | path | string | string | ✓ | | Name of the template group |
| `version` | query | string | string | | | Current version of the resource. Used for optimistic concurrency validation. Keep empty to bypass validation. |
2024-02-12 17:27:18 +08:00
#### All responses
| Code | Status | Description | Has headers | Schema |
| --------------------------------- | ---------- | -------------------------------------- | :---------: | ------------------------------------------- |
| [204 ](#route-delete-template-204 ) | No Content | The template was deleted successfully. | | [schema ](#route-delete-template-204-schema ) |
2024-08-09 23:40:07 +08:00
| [409 ](#route-delete-template-409 ) | Conflict | GenericPublicError | | [schema ](#route-delete-template-409-schema ) |
2024-02-12 17:27:18 +08:00
#### Responses
##### <span id="route-delete-template-204"></span> 204 - The template was deleted successfully.
Status: No Content
###### <span id="route-delete-template-204-schema"></span> Schema
2024-08-09 23:40:07 +08:00
##### <span id="route-delete-template-409"></span> 409 - Conflict
Status: Conflict
###### <span id="route-delete-template-409-schema"></span> Schema
[GenericPublicError ](#generic-public-error )
2024-02-12 17:27:18 +08:00
### <span id="route-get-alert-rule"></span> Get a specific alert rule by UID. (_RouteGetAlertRule_)
```
GET /api/v1/provisioning/alert-rules/:uid
```
#### Parameters
2025-03-10 18:33:30 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| ----- | ------ | ------ | ------- | :------: | ------- | -------------- |
| `UID` | path | string | string | ✓ | | Alert rule UID |
2024-02-12 17:27:18 +08:00
#### All responses
| Code | Status | Description | Has headers | Schema |
| -------------------------------- | --------- | -------------------- | :---------: | ------------------------------------------ |
| [200 ](#route-get-alert-rule-200 ) | OK | ProvisionedAlertRule | | [schema ](#route-get-alert-rule-200-schema ) |
| [404 ](#route-get-alert-rule-404 ) | Not Found | Not found. | | [schema ](#route-get-alert-rule-404-schema ) |
#### Responses
##### <span id="route-get-alert-rule-200"></span> 200 - ProvisionedAlertRule
Status: OK
###### <span id="route-get-alert-rule-200-schema"></span> Schema
[ProvisionedAlertRule ](#provisioned-alert-rule )
##### <span id="route-get-alert-rule-404"></span> 404 - Not found.
Status: Not Found
###### <span id="route-get-alert-rule-404-schema"></span> Schema
### <span id="route-get-alert-rule-export"></span> Export an alert rule in provisioning file format. (_RouteGetAlertRuleExport_)
```
GET /api/v1/provisioning/alert-rules/:uid/export
```
2025-03-10 18:33:30 +08:00
{{< docs / shared lookup = "alerts/alerting-provisioning-export-produces.md" source = "grafana" version = "<GRAFANA_VERSION>" > }}
2024-02-12 17:27:18 +08:00
#### Parameters
2025-03-10 18:33:30 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| ---------- | ------ | ------- | ------- | :------: | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `UID` | path | string | string | ✓ | | Alert rule UID |
| `download` | query | boolean | `bool` | | | Whether to initiate a download of the file or not. |
| `format` | query | string | string | | `yaml` | Format of the downloaded file, either `yaml` , `json` or `hcl` . Accept header can also be used, but the query parameter will take precedence. |
2024-02-12 17:27:18 +08:00
#### All responses
| Code | Status | Description | Has headers | Schema |
| --------------------------------------- | --------- | ------------------ | :---------: | ------------------------------------------------- |
| [200 ](#route-get-alert-rule-export-200 ) | OK | AlertingFileExport | | [schema ](#route-get-alert-rule-export-200-schema ) |
| [404 ](#route-get-alert-rule-export-404 ) | Not Found | Not found. | | [schema ](#route-get-alert-rule-export-404-schema ) |
#### Responses
##### <span id="route-get-alert-rule-export-200"></span> 200 - AlertingFileExport
Status: OK
###### <span id="route-get-alert-rule-export-200-schema"></span> Schema
[AlertingFileExport ](#alerting-file-export )
##### <span id="route-get-alert-rule-export-404"></span> 404 - Not found.
Status: Not Found
###### <span id="route-get-alert-rule-export-404-schema"></span> Schema
### <span id="route-get-alert-rule-group"></span> Get a rule group. (_RouteGetAlertRuleGroup_)
```
GET /api/v1/provisioning/folder/:folderUid/rule-groups/:group
```
#### Parameters
2025-03-10 18:33:30 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| ----------- | ------ | ------ | ------- | :------: | ------- | ----------- |
| `FolderUID` | path | string | string | ✓ | | |
| `Group` | path | string | string | ✓ | | |
2024-02-12 17:27:18 +08:00
#### All responses
| Code | Status | Description | Has headers | Schema |
| -------------------------------------- | --------- | -------------- | :---------: | ------------------------------------------------ |
| [200 ](#route-get-alert-rule-group-200 ) | OK | AlertRuleGroup | | [schema ](#route-get-alert-rule-group-200-schema ) |
| [404 ](#route-get-alert-rule-group-404 ) | Not Found | Not found. | | [schema ](#route-get-alert-rule-group-404-schema ) |
#### Responses
##### <span id="route-get-alert-rule-group-200"></span> 200 - AlertRuleGroup
Status: OK
###### <span id="route-get-alert-rule-group-200-schema"></span> Schema
[AlertRuleGroup ](#alert-rule-group )
##### <span id="route-get-alert-rule-group-404"></span> 404 - Not found.
Status: Not Found
###### <span id="route-get-alert-rule-group-404-schema"></span> Schema
### <span id="route-get-alert-rule-group-export"></span> Export an alert rule group in provisioning file format. (_RouteGetAlertRuleGroupExport_)
```
GET /api/v1/provisioning/folder/:folderUid/rule-groups/:group/export
```
2025-03-10 18:33:30 +08:00
{{< docs / shared lookup = "alerts/alerting-provisioning-export-produces.md" source = "grafana" version = "<GRAFANA_VERSION>" > }}
2024-02-12 17:27:18 +08:00
#### Parameters
2025-03-10 18:33:30 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| ----------- | ------ | ------- | ------- | :------: | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `FolderUID` | path | string | string | ✓ | | |
| `Group` | path | string | string | ✓ | | |
| `download` | query | boolean | `bool` | | | Whether to initiate a download of the file or not. |
| `format` | query | string | string | | `yaml` | Format of the downloaded file, either `yaml` , `json` or `hcl` . Accept header can also be used, but the query parameter will take precedence. |
2024-02-12 17:27:18 +08:00
#### All responses
| Code | Status | Description | Has headers | Schema |
| --------------------------------------------- | --------- | ------------------ | :---------: | ------------------------------------------------------- |
| [200 ](#route-get-alert-rule-group-export-200 ) | OK | AlertingFileExport | | [schema ](#route-get-alert-rule-group-export-200-schema ) |
| [404 ](#route-get-alert-rule-group-export-404 ) | Not Found | Not found. | | [schema ](#route-get-alert-rule-group-export-404-schema ) |
#### Responses
##### <span id="route-get-alert-rule-group-export-200"></span> 200 - AlertingFileExport
Status: OK
###### <span id="route-get-alert-rule-group-export-200-schema"></span> Schema
[AlertingFileExport ](#alerting-file-export )
##### <span id="route-get-alert-rule-group-export-404"></span> 404 - Not found.
Status: Not Found
###### <span id="route-get-alert-rule-group-export-404-schema"></span> Schema
### <span id="route-get-alert-rules"></span> Get all the alert rules. (_RouteGetAlertRules_)
```
GET /api/v1/provisioning/alert-rules
```
#### All responses
| Code | Status | Description | Has headers | Schema |
| --------------------------------- | ------ | --------------------- | :---------: | ------------------------------------------- |
| [200 ](#route-get-alert-rules-200 ) | OK | ProvisionedAlertRules | | [schema ](#route-get-alert-rules-200-schema ) |
#### Responses
##### <span id="route-get-alert-rules-200"></span> 200 - ProvisionedAlertRules
Status: OK
###### <span id="route-get-alert-rules-200-schema"></span> Schema
[ProvisionedAlertRules ](#provisioned-alert-rules )
### <span id="route-get-alert-rules-export"></span> Export all alert rules in provisioning file format. (_RouteGetAlertRulesExport_)
```
GET /api/v1/provisioning/alert-rules/export
```
2025-03-10 18:33:30 +08:00
{{< docs / shared lookup = "alerts/alerting-provisioning-export-produces.md" source = "grafana" version = "<GRAFANA_VERSION>" > }}
2024-03-23 00:25:27 +08:00
2024-02-12 17:27:18 +08:00
#### Parameters
2025-03-10 18:33:30 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| ---------- | ------ | ------- | ------- | :------: | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `download` | query | boolean | `bool` | | | Whether to initiate a download of the file or not. |
| `format` | query | string | string | | `yaml` | Format of the downloaded file, either `yaml` , `json` or `hcl` . Accept header can also be used, but the query parameter will take precedence. |
2024-02-12 17:27:18 +08:00
#### All responses
| Code | Status | Description | Has headers | Schema |
| ---------------------------------------- | --------- | ------------------ | :---------: | -------------------------------------------------- |
| [200 ](#route-get-alert-rules-export-200 ) | OK | AlertingFileExport | | [schema ](#route-get-alert-rules-export-200-schema ) |
| [404 ](#route-get-alert-rules-export-404 ) | Not Found | Not found. | | [schema ](#route-get-alert-rules-export-404-schema ) |
#### Responses
##### <span id="route-get-alert-rules-export-200"></span> 200 - AlertingFileExport
Status: OK
###### <span id="route-get-alert-rules-export-200-schema"></span> Schema
[AlertingFileExport ](#alerting-file-export )
##### <span id="route-get-alert-rules-export-404"></span> 404 - Not found.
Status: Not Found
###### <span id="route-get-alert-rules-export-404-schema"></span> Schema
### <span id="route-get-contactpoints"></span> Get all the contact points. (_RouteGetContactpoints_)
```
GET /api/v1/provisioning/contact-points
```
#### Parameters
2025-03-10 18:33:30 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| ------ | ------ | ------ | ------- | :------: | ------- | -------------- |
| `name` | query | string | string | | | Filter by name |
2024-02-12 17:27:18 +08:00
#### All responses
| Code | Status | Description | Has headers | Schema |
| ----------------------------------- | ------ | ------------- | :---------: | --------------------------------------------- |
| [200 ](#route-get-contactpoints-200 ) | OK | ContactPoints | | [schema ](#route-get-contactpoints-200-schema ) |
#### Responses
##### <span id="route-get-contactpoints-200"></span> 200 - ContactPoints
Status: OK
###### <span id="route-get-contactpoints-200-schema"></span> Schema
[ContactPoints ](#contact-points )
### <span id="route-get-contactpoints-export"></span> Export all contact points in provisioning file format. (_RouteGetContactpointsExport_)
```
GET /api/v1/provisioning/contact-points/export
```
2025-03-10 18:33:30 +08:00
{{< docs / shared lookup = "alerts/alerting-provisioning-export-produces.md" source = "grafana" version = "<GRAFANA_VERSION>" > }}
2024-03-23 00:25:27 +08:00
2024-02-12 17:27:18 +08:00
#### Parameters
2025-03-10 18:33:30 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| ---------- | ------ | ------- | ------- | :------: | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `decrypt` | query | boolean | `bool` | | | Whether any contained secure settings should be decrypted or left redacted. Redacted settings will contain RedactedValue instead. Currently, only org admin can view decrypted secure settings. |
| `download` | query | boolean | `bool` | | | Whether to initiate a download of the file or not. |
| `format` | query | string | string | | `yaml` | Format of the downloaded file, either `yaml` , `json` or `hcl` . Accept header can also be used, but the query parameter will take precedence. |
| `name` | query | string | string | | | Filter by name |
2024-02-12 17:27:18 +08:00
#### All responses
| Code | Status | Description | Has headers | Schema |
| ------------------------------------------ | --------- | ------------------ | :---------: | ---------------------------------------------------- |
| [200 ](#route-get-contactpoints-export-200 ) | OK | AlertingFileExport | | [schema ](#route-get-contactpoints-export-200-schema ) |
| [403 ](#route-get-contactpoints-export-403 ) | Forbidden | PermissionDenied | | [schema ](#route-get-contactpoints-export-403-schema ) |
#### Responses
##### <span id="route-get-contactpoints-export-200"></span> 200 - AlertingFileExport
Status: OK
###### <span id="route-get-contactpoints-export-200-schema"></span> Schema
[AlertingFileExport ](#alerting-file-export )
##### <span id="route-get-contactpoints-export-403"></span> 403 - PermissionDenied
Status: Forbidden
###### <span id="route-get-contactpoints-export-403-schema"></span> Schema
[PermissionDenied ](#permission-denied )
### <span id="route-get-mute-timing"></span> Get a mute timing. (_RouteGetMuteTiming_)
```
GET /api/v1/provisioning/mute-timings/:name
```
#### Parameters
2025-03-10 18:33:30 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| ------ | ------ | ------ | ------- | :------: | ------- | ---------------- |
| `name` | path | string | string | ✓ | | Mute timing name |
2024-02-12 17:27:18 +08:00
#### All responses
| Code | Status | Description | Has headers | Schema |
| --------------------------------- | --------- | ---------------- | :---------: | ------------------------------------------- |
| [200 ](#route-get-mute-timing-200 ) | OK | MuteTimeInterval | | [schema ](#route-get-mute-timing-200-schema ) |
| [404 ](#route-get-mute-timing-404 ) | Not Found | Not found. | | [schema ](#route-get-mute-timing-404-schema ) |
#### Responses
##### <span id="route-get-mute-timing-200"></span> 200 - MuteTimeInterval
Status: OK
###### <span id="route-get-mute-timing-200-schema"></span> Schema
[MuteTimeInterval ](#mute-time-interval )
##### <span id="route-get-mute-timing-404"></span> 404 - Not found.
Status: Not Found
###### <span id="route-get-mute-timing-404-schema"></span> Schema
### <span id="route-get-mute-timings"></span> Get all the mute timings. (_RouteGetMuteTimings_)
```
GET /api/v1/provisioning/mute-timings
```
#### All responses
| Code | Status | Description | Has headers | Schema |
| ---------------------------------- | ------ | ----------- | :---------: | -------------------------------------------- |
| [200 ](#route-get-mute-timings-200 ) | OK | MuteTimings | | [schema ](#route-get-mute-timings-200-schema ) |
#### Responses
##### <span id="route-get-mute-timings-200"></span> 200 - MuteTimings
Status: OK
###### <span id="route-get-mute-timings-200-schema"></span> Schema
[MuteTimings ](#mute-timings )
2024-03-04 17:50:44 +08:00
### <span id="route-get-mute-timings-export"></span> Export all mute timings in provisioning file format. (_RouteGetMuteTimingsExport_)
```
GET /api/v1/provisioning/mute-timings/export
```
2025-03-10 18:33:30 +08:00
{{< docs / shared lookup = "alerts/alerting-provisioning-export-produces.md" source = "grafana" version = "<GRAFANA_VERSION>" > }}
2024-03-23 00:25:27 +08:00
2024-03-04 17:50:44 +08:00
#### Parameters
2025-03-10 18:33:30 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| ---------- | ------ | ------- | ------- | :------: | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `download` | query | boolean | `bool` | | | Whether to initiate a download of the file or not. |
| `format` | query | string | string | | `yaml` | Format of the downloaded file, either `yaml` , `json` or `hcl` . Accept header can also be used, but the query parameter will take precedence. |
2024-03-04 17:50:44 +08:00
#### All responses
| Code | Status | Description | Has headers | Schema |
| ----------------------------------------- | --------- | ----------------- | :---------: | --------------------------------------------------- |
| [200 ](#route-get-mute-timings-export-200 ) | OK | MuteTimingsExport | | [schema ](#route-get-mute-timings-export-200-schema ) |
| [403 ](#route-get-mute-timings-export-403 ) | Forbidden | PermissionDenied | | [schema ](#route-get-mute-timings-export-403-schema ) |
#### Responses
##### <span id="route-get-mute-timings-export-200"></span> 200 - MuteTimingsExport
Status: OK
###### <span id="route-get-mute-timings-export-200-schema"></span> Schema
[AlertingFileExport ](#alerting-file-export )
##### <span id="route-get-mute-timings-export-403"></span> 403 - PermissionDenied
Status: Forbidden
###### <span id="route-get-mute-timings-export-403-schema"></span> Schema
[PermissionDenied ](#permission-denied )
### <span id="route-get-mute-timing-export"></span> Export a mute timing in provisioning file format. (_RouteGetMuteTimingExport_)
```
GET /api/v1/provisioning/mute-timings/:name/export
```
2025-03-10 18:33:30 +08:00
{{< docs / shared lookup = "alerts/alerting-provisioning-export-produces.md" source = "grafana" version = "<GRAFANA_VERSION>" > }}
2024-03-23 00:25:27 +08:00
2024-03-04 17:50:44 +08:00
#### Parameters
2025-03-10 18:33:30 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| ---------- | ------ | ------- | ------- | :------: | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | path | string | string | ✓ | | Mute timing name. |
| `download` | query | boolean | `bool` | | | Whether to initiate a download of the file or not. |
| `format` | query | string | string | | `yaml` | Format of the downloaded file, either `yaml` , `json` or `hcl` . Accept header can also be used, but the query parameter will take precedence. |
2024-03-04 17:50:44 +08:00
#### All responses
| Code | Status | Description | Has headers | Schema |
| ---------------------------------------- | --------- | ---------------- | :---------: | --------------------------------------------------- |
| [200 ](#route-get-mute-timing-export-200 ) | OK | MuteTimingExport | | [schema ](#route-get-mute-timings-export-200-schema ) |
| [403 ](#route-get-mute-timing-export-403 ) | Forbidden | PermissionDenied | | [schema ](#route-get-mute-timings-export-403-schema ) |
#### Responses
##### <span id="route-get-mute-timing-export-200"></span> 200 - MuteTimingExport
Status: OK
###### <span id="route-get-mute-timing-export-200-schema"></span> Schema
[AlertingFileExport ](#alerting-file-export )
##### <span id="route-get-mute-timing-export-403"></span> 403 - PermissionDenied
Status: Forbidden
###### <span id="route-get-mute-timing-export-403-schema"></span> Schema
[PermissionDenied ](#permission-denied )
2024-02-12 17:27:18 +08:00
### <span id="route-get-policy-tree"></span> Get the notification policy tree. (_RouteGetPolicyTree_)
```
GET /api/v1/provisioning/policies
```
#### All responses
| Code | Status | Description | Has headers | Schema |
| --------------------------------- | ------ | ----------- | :---------: | ------------------------------------------- |
| [200 ](#route-get-policy-tree-200 ) | OK | Route | | [schema ](#route-get-policy-tree-200-schema ) |
#### Responses
##### <span id="route-get-policy-tree-200"></span> 200 - Route
Status: OK
###### <span id="route-get-policy-tree-200-schema"></span> Schema
[Route ](#route )
### <span id="route-get-policy-tree-export"></span> Export the notification policy tree in provisioning file format. (_RouteGetPolicyTreeExport_)
```
GET /api/v1/provisioning/policies/export
```
2025-03-10 18:33:30 +08:00
{{< docs / shared lookup = "alerts/alerting-provisioning-export-produces.md" source = "grafana" version = "<GRAFANA_VERSION>" > }}
2024-03-23 00:25:27 +08:00
#### Parameters
2025-03-10 18:33:30 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| ---------- | ------ | ------- | ------- | :------: | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `download` | query | boolean | `bool` | | | Whether to initiate a download of the file or not. |
| `format` | query | string | string | | `yaml` | Format of the downloaded file, either `yaml` , `json` or `hcl` . Accept header can also be used, but the query parameter will take precedence. |
2024-03-23 00:25:27 +08:00
2024-02-12 17:27:18 +08:00
#### All responses
| Code | Status | Description | Has headers | Schema |
| ---------------------------------------- | --------- | ------------------ | :---------: | -------------------------------------------------- |
| [200 ](#route-get-policy-tree-export-200 ) | OK | AlertingFileExport | | [schema ](#route-get-policy-tree-export-200-schema ) |
| [404 ](#route-get-policy-tree-export-404 ) | Not Found | NotFound | | [schema ](#route-get-policy-tree-export-404-schema ) |
#### Responses
##### <span id="route-get-policy-tree-export-200"></span> 200 - AlertingFileExport
Status: OK
###### <span id="route-get-policy-tree-export-200-schema"></span> Schema
[AlertingFileExport ](#alerting-file-export )
##### <span id="route-get-policy-tree-export-404"></span> 404 - NotFound
Status: Not Found
###### <span id="route-get-policy-tree-export-404-schema"></span> Schema
[NotFound ](#not-found )
2024-11-22 20:40:20 +08:00
### <span id="route-get-template"></span> Get a notification template group. (_RouteGetTemplate_)
2024-02-12 17:27:18 +08:00
```
GET /api/v1/provisioning/templates/:name
```
#### Parameters
2025-03-10 18:33:30 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| ------ | ------ | ------ | ------- | :------: | ------- | -------------------------- |
| `name` | path | string | string | ✓ | | Name of the template group |
2024-02-12 17:27:18 +08:00
#### All responses
| Code | Status | Description | Has headers | Schema |
| ------------------------------ | --------- | -------------------- | :---------: | ---------------------------------------- |
| [200 ](#route-get-template-200 ) | OK | NotificationTemplate | | [schema ](#route-get-template-200-schema ) |
2024-08-13 22:59:19 +08:00
| [404 ](#route-get-template-404 ) | Not Found | GenericPublicError | | [schema ](#route-get-template-404-schema ) |
2024-02-12 17:27:18 +08:00
#### Responses
##### <span id="route-get-template-200"></span> 200 - NotificationTemplate
Status: OK
###### <span id="route-get-template-200-schema"></span> Schema
[NotificationTemplate ](#notification-template )
##### <span id="route-get-template-404"></span> 404 - Not found.
2024-08-13 22:59:19 +08:00
[GenericPublicError ](#generic-public-error )
2024-02-12 17:27:18 +08:00
###### <span id="route-get-template-404-schema"></span> Schema
2024-11-22 20:40:20 +08:00
### <span id="route-get-templates"></span> Get all notification template groups. (_RouteGetTemplates_)
2024-02-12 17:27:18 +08:00
```
GET /api/v1/provisioning/templates
```
#### All responses
2024-08-13 22:59:19 +08:00
| Code | Status | Description | Has headers | Schema |
| ------------------------------- | ------ | --------------------- | :---------: | ----------------------------------------- |
| [200 ](#route-get-templates-200 ) | OK | NotificationTemplates | | [schema ](#route-get-templates-200-schema ) |
2024-02-12 17:27:18 +08:00
#### Responses
##### <span id="route-get-templates-200"></span> 200 - NotificationTemplates
Status: OK
###### <span id="route-get-templates-200-schema"></span> Schema
[NotificationTemplates ](#notification-templates )
### <span id="route-post-alert-rule"></span> Create a new alert rule. (_RoutePostAlertRule_)
```
POST /api/v1/provisioning/alert-rules
```
2025-05-28 17:11:56 +08:00
This action creates a new alert rule.
The provenance (`X-Disable-Provenance`) of the new rule must match the provenance configured for its rule group. Mixing provisioned and unprovisioned alert rules within the same rule group is not allowed.
2024-02-12 17:27:18 +08:00
#### Parameters
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| ---------------------------- | ------ | ----------------------------------------------- | ----------------------------- | :------: | ------- | --------------------------------------------------------- |
| `X-Disable-Provenance: true` | header | string | string | | | Allows editing of provisioned resources in the Grafana UI |
| `Body` | body | [ProvisionedAlertRule ](#provisioned-alert-rule ) | `models.ProvisionedAlertRule` | | | |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
#### All responses
| Code | Status | Description | Has headers | Schema |
| --------------------------------- | ----------- | -------------------- | :---------: | ------------------------------------------- |
| [201 ](#route-post-alert-rule-201 ) | Created | ProvisionedAlertRule | | [schema ](#route-post-alert-rule-201-schema ) |
| [400 ](#route-post-alert-rule-400 ) | Bad Request | ValidationError | | [schema ](#route-post-alert-rule-400-schema ) |
#### Responses
##### <span id="route-post-alert-rule-201"></span> 201 - ProvisionedAlertRule
Status: Created
###### <span id="route-post-alert-rule-201-schema"></span> Schema
[ProvisionedAlertRule ](#provisioned-alert-rule )
##### <span id="route-post-alert-rule-400"></span> 400 - ValidationError
Status: Bad Request
###### <span id="route-post-alert-rule-400-schema"></span> Schema
[ValidationError ](#validation-error )
### <span id="route-post-contactpoints"></span> Create a contact point. (_RoutePostContactpoints_)
```
POST /api/v1/provisioning/contact-points
```
2024-11-06 22:28:44 +08:00
When creating a contact point, the `EmbeddedContactPoint.name` property determines if the new contact point is added to an existing one. In the UI, contact points with the same name are grouped together under a single contact point.
2024-02-12 17:27:18 +08:00
#### Parameters
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| ---------------------------- | ------ | ----------------------------------------------- | ----------------------------- | :------: | ------- | --------------------------------------------------------- |
| `X-Disable-Provenance: true` | header | string | string | | | Allows editing of provisioned resources in the Grafana UI |
| `Body` | body | [EmbeddedContactPoint ](#embedded-contact-point ) | `models.EmbeddedContactPoint` | | | |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
#### All responses
| Code | Status | Description | Has headers | Schema |
| ------------------------------------ | ----------- | -------------------- | :---------: | ---------------------------------------------- |
| [202 ](#route-post-contactpoints-202 ) | Accepted | EmbeddedContactPoint | | [schema ](#route-post-contactpoints-202-schema ) |
| [400 ](#route-post-contactpoints-400 ) | Bad Request | ValidationError | | [schema ](#route-post-contactpoints-400-schema ) |
#### Responses
##### <span id="route-post-contactpoints-202"></span> 202 - EmbeddedContactPoint
Status: Accepted
###### <span id="route-post-contactpoints-202-schema"></span> Schema
[EmbeddedContactPoint ](#embedded-contact-point )
##### <span id="route-post-contactpoints-400"></span> 400 - ValidationError
Status: Bad Request
###### <span id="route-post-contactpoints-400-schema"></span> Schema
[ValidationError ](#validation-error )
### <span id="route-post-mute-timing"></span> Create a new mute timing. (_RoutePostMuteTiming_)
```
POST /api/v1/provisioning/mute-timings
```
#### Parameters
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| ---------------------------- | ------ | --------------------------------------- | ------------------------- | :------: | ------- | --------------------------------------------------------- |
| `X-Disable-Provenance: true` | header | string | string | | | Allows editing of provisioned resources in the Grafana UI |
| `Body` | body | [MuteTimeInterval ](#mute-time-interval ) | `models.MuteTimeInterval` | | | |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
#### All responses
| Code | Status | Description | Has headers | Schema |
| ---------------------------------- | ----------- | ---------------- | :---------: | -------------------------------------------- |
| [201 ](#route-post-mute-timing-201 ) | Created | MuteTimeInterval | | [schema ](#route-post-mute-timing-201-schema ) |
| [400 ](#route-post-mute-timing-400 ) | Bad Request | ValidationError | | [schema ](#route-post-mute-timing-400-schema ) |
#### Responses
##### <span id="route-post-mute-timing-201"></span> 201 - MuteTimeInterval
Status: Created
###### <span id="route-post-mute-timing-201-schema"></span> Schema
[MuteTimeInterval ](#mute-time-interval )
##### <span id="route-post-mute-timing-400"></span> 400 - ValidationError
Status: Bad Request
###### <span id="route-post-mute-timing-400-schema"></span> Schema
[ValidationError ](#validation-error )
### <span id="route-put-alert-rule"></span> Update an existing alert rule. (_RoutePutAlertRule_)
```
PUT /api/v1/provisioning/alert-rules/:uid
```
#### Parameters
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| ---------------------------- | ------ | ----------------------------------------------- | ----------------------------- | :------: | ------- | --------------------------------------------------------- | --- |
| `UID` | path | string | string | ✓ | | Alert rule UID |
| `X-Disable-Provenance: true` | header | string | string | | | Allows editing of provisioned resources in the Grafana UI |
| `Body` | body | [ProvisionedAlertRule ](#provisioned-alert-rule ) | `models.ProvisionedAlertRule` | | | | |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
#### All responses
| Code | Status | Description | Has headers | Schema |
| -------------------------------- | ----------- | -------------------- | :---------: | ------------------------------------------ |
| [200 ](#route-put-alert-rule-200 ) | OK | ProvisionedAlertRule | | [schema ](#route-put-alert-rule-200-schema ) |
| [400 ](#route-put-alert-rule-400 ) | Bad Request | ValidationError | | [schema ](#route-put-alert-rule-400-schema ) |
#### Responses
##### <span id="route-put-alert-rule-200"></span> 200 - ProvisionedAlertRule
Status: OK
###### <span id="route-put-alert-rule-200-schema"></span> Schema
[ProvisionedAlertRule ](#provisioned-alert-rule )
##### <span id="route-put-alert-rule-400"></span> 400 - ValidationError
Status: Bad Request
###### <span id="route-put-alert-rule-400-schema"></span> Schema
[ValidationError ](#validation-error )
2025-06-17 16:40:57 +08:00
### <span id="route-put-alert-rule-group"></span> Create or update a rule group. (_RoutePutAlertRuleGroup_)
2024-02-12 17:27:18 +08:00
```
PUT /api/v1/provisioning/folder/:folderUid/rule-groups/:group
```
2025-05-28 17:11:56 +08:00
This action also changes the provenance setting (`X-Disable-Provenance`) for all alert rules in the alert group.
2024-02-12 17:27:18 +08:00
#### Parameters
{{% responsive-table %}}
2025-05-28 17:11:56 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| ---------------------------- | ------ | ----------------------------------- | ----------------------- | :------: | ------- | ----------------------------------------------------------------------------------------------------------------------- |
| `FolderUID` | path | string | string | ✓ | | |
| `Group` | path | string | string | ✓ | | |
| `X-Disable-Provenance: true` | header | string | string | | | Allows editing of provisioned resources in the Grafana UI. This also applies to all alert rules within the alert group. |
| `Body` | body | [AlertRuleGroup ](#alert-rule-group ) | `models.AlertRuleGroup` | | | This action is idempotent and rules included in this body will overwrite configured rules for the group |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
#### All responses
| Code | Status | Description | Has headers | Schema |
| -------------------------------------- | ----------- | --------------- | :---------: | ------------------------------------------------ |
| [200 ](#route-put-alert-rule-group-200 ) | OK | AlertRuleGroup | | [schema ](#route-put-alert-rule-group-200-schema ) |
| [400 ](#route-put-alert-rule-group-400 ) | Bad Request | ValidationError | | [schema ](#route-put-alert-rule-group-400-schema ) |
#### Responses
##### <span id="route-put-alert-rule-group-200"></span> 200 - AlertRuleGroup
Status: OK
###### <span id="route-put-alert-rule-group-200-schema"></span> Schema
[AlertRuleGroup ](#alert-rule-group )
##### <span id="route-put-alert-rule-group-400"></span> 400 - ValidationError
Status: Bad Request
###### <span id="route-put-alert-rule-group-400-schema"></span> Schema
[ValidationError ](#validation-error )
### <span id="route-put-contactpoint"></span> Update an existing contact point. (_RoutePutContactpoint_)
```
PUT /api/v1/provisioning/contact-points/:uid
```
#### Parameters
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| ---------------------------- | ------ | ----------------------------------------------- | ----------------------------- | :------: | ------- | --------------------------------------------------------- |
| `UID` | path | string | string | ✓ | | UID is the contact point unique identifier |
| `X-Disable-Provenance: true` | header | string | string | | | Allows editing of provisioned resources in the Grafana UI |
| `Body` | body | [EmbeddedContactPoint ](#embedded-contact-point ) | `models.EmbeddedContactPoint` | | | |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
#### All responses
| Code | Status | Description | Has headers | Schema |
| ---------------------------------- | ----------- | --------------- | :---------: | -------------------------------------------- |
| [202 ](#route-put-contactpoint-202 ) | Accepted | Ack | | [schema ](#route-put-contactpoint-202-schema ) |
| [400 ](#route-put-contactpoint-400 ) | Bad Request | ValidationError | | [schema ](#route-put-contactpoint-400-schema ) |
#### Responses
##### <span id="route-put-contactpoint-202"></span> 202 - Ack
Status: Accepted
###### <span id="route-put-contactpoint-202-schema"></span> Schema
[Ack ](#ack )
##### <span id="route-put-contactpoint-400"></span> 400 - ValidationError
Status: Bad Request
###### <span id="route-put-contactpoint-400-schema"></span> Schema
[ValidationError ](#validation-error )
### <span id="route-put-mute-timing"></span> Replace an existing mute timing. (_RoutePutMuteTiming_)
```
PUT /api/v1/provisioning/mute-timings/:name
```
#### Parameters
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| ---------------------------- | ------ | --------------------------------------- | ------------------------- | -------- | :-----: | --------------------------------------------------------- |
| `name` | path | string | string | ✓ | | Mute timing name |
| `X-Disable-Provenance: true` | header | string | string | | | Allows editing of provisioned resources in the Grafana UI |
| `Body` | body | [MuteTimeInterval ](#mute-time-interval ) | `models.MuteTimeInterval` | | | |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
#### All responses
2024-08-09 23:40:07 +08:00
| Code | Status | Description | Has headers | Schema |
| --------------------------------- | ----------- | ------------------ | :---------: | ------------------------------------------- |
| [200 ](#route-put-mute-timing-200 ) | OK | MuteTimeInterval | | [schema ](#route-put-mute-timing-200-schema ) |
| [400 ](#route-put-mute-timing-400 ) | Bad Request | ValidationError | | [schema ](#route-put-mute-timing-400-schema ) |
| [409 ](#route-put-mute-timing-409 ) | Conflict | GenericPublicError | | [schema ](#route-put-mute-timing-409-schema ) |
2024-02-12 17:27:18 +08:00
#### Responses
##### <span id="route-put-mute-timing-200"></span> 200 - MuteTimeInterval
Status: OK
###### <span id="route-put-mute-timing-200-schema"></span> Schema
[MuteTimeInterval ](#mute-time-interval )
##### <span id="route-put-mute-timing-400"></span> 400 - ValidationError
Status: Bad Request
###### <span id="route-put-mute-timing-400-schema"></span> Schema
[ValidationError ](#validation-error )
2024-08-09 23:40:07 +08:00
##### <span id="route-put-mute-timing-409"></span> 409 - Conflict
Status: Conflict
###### <span id="route-put-mute-timing-409-schema"></span> Schema
[GenericPublicError ](#generic-public-error )
2024-02-12 17:27:18 +08:00
### <span id="route-put-policy-tree"></span> Sets the notification policy tree. (_RoutePutPolicyTree_)
2025-03-11 22:58:25 +08:00
{{< docs / shared lookup = "alerts/warning-provisioning-tree.md" source = "grafana" version = "<GRAFANA_VERSION>" > }}
2024-02-12 17:27:18 +08:00
```
PUT /api/v1/provisioning/policies
```
#### Parameters
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| ---------------------------- | ------ | --------------- | -------------- | :------: | ------- | --------------------------------------------------------- |
| `X-Disable-Provenance: true` | header | string | string | | | Allows editing of provisioned resources in the Grafana UI |
| `Body` | body | [Route ](#route ) | `models.Route` | | | The new notification routing tree to use |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
#### All responses
| Code | Status | Description | Has headers | Schema |
| --------------------------------- | ----------- | --------------- | :---------: | ------------------------------------------- |
| [202 ](#route-put-policy-tree-202 ) | Accepted | Ack | | [schema ](#route-put-policy-tree-202-schema ) |
| [400 ](#route-put-policy-tree-400 ) | Bad Request | ValidationError | | [schema ](#route-put-policy-tree-400-schema ) |
#### Responses
##### <span id="route-put-policy-tree-202"></span> 202 - Ack
Status: Accepted
###### <span id="route-put-policy-tree-202-schema"></span> Schema
[Ack ](#ack )
##### <span id="route-put-policy-tree-400"></span> 400 - ValidationError
Status: Bad Request
###### <span id="route-put-policy-tree-400-schema"></span> Schema
[ValidationError ](#validation-error )
2024-11-22 20:40:20 +08:00
### <span id="route-put-template"></span> Create or update a notification template group. (_RoutePutTemplate_)
2024-02-12 17:27:18 +08:00
```
PUT /api/v1/provisioning/templates/:name
```
{{% responsive-table %}}
#### Parameters
2025-03-10 18:33:30 +08:00
| Name | Source | Type | Go type | Required | Default | Description |
| ---------------------------- | ------ | ------------------------------------------------------------- | ------------------------------------ | -------- | :-----: | --------------------------------------------------------- | --- |
| `name` | path | string | string | ✓ | | Name of the template group |
| `X-Disable-Provenance: true` | header | string | string | | | Allows editing of provisioned resources in the Grafana UI |
| `Body` | body | [NotificationTemplateContent ](#notification-template-content ) | `models.NotificationTemplateContent` | | | | |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
#### All responses
| Code | Status | Description | Has headers | Schema |
| ------------------------------ | ----------- | -------------------- | :---------: | ---------------------------------------- |
| [202 ](#route-put-template-202 ) | Accepted | NotificationTemplate | | [schema ](#route-put-template-202-schema ) |
2024-08-13 22:59:19 +08:00
| [400 ](#route-put-template-400 ) | Bad Request | GenericPublicError | | [schema ](#route-put-template-400-schema ) |
2024-08-09 23:40:07 +08:00
| [409 ](#route-put-template-409 ) | Conflict | GenericPublicError | | [schema ](#route-put-template-409-schema ) |
2024-02-12 17:27:18 +08:00
#### Responses
##### <span id="route-put-template-202"></span> 202 - NotificationTemplate
Status: Accepted
###### <span id="route-put-template-202-schema"></span> Schema
[NotificationTemplate ](#notification-template )
##### <span id="route-put-template-400"></span> 400 - ValidationError
Status: Bad Request
###### <span id="route-put-template-400-schema"></span> Schema
2024-08-13 22:59:19 +08:00
[GenericPublicError ](#generic-public-error )
2024-02-12 17:27:18 +08:00
2024-08-09 23:40:07 +08:00
##### <span id="route-put-template-409"></span> 409 - Conflict
Status: Conflict
###### <span id="route-put-template-409-schema"></span> Schema
[GenericPublicError ](#generic-public-error )
2024-02-12 17:27:18 +08:00
### <span id="route-reset-policy-tree"></span> Clears the notification policy tree. (_RouteResetPolicyTree_)
```
DELETE /api/v1/provisioning/policies
```
#### All responses
| Code | Status | Description | Has headers | Schema |
| ----------------------------------- | -------- | ----------- | :---------: | --------------------------------------------- |
| [202 ](#route-reset-policy-tree-202 ) | Accepted | Ack | | [schema ](#route-reset-policy-tree-202-schema ) |
#### Responses
##### <span id="route-reset-policy-tree-202"></span> 202 - Ack
Status: Accepted
###### <span id="route-reset-policy-tree-202-schema"></span> Schema
[Ack ](#ack )
## Models
### <span id="ack"></span> Ack
[interface{} ](#interface )
### <span id="alert-query"></span> AlertQuery
**Properties**
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Type | Go type | Required | Default | Description | Example |
| ------------------- | ----------------------------------------- | ------------------- | :------: | ------- | -------------------------------------------------------------------------------------------------------------------- | ------- |
| `datasourceUid` | string | string | | | Grafana data source unique identifier; it should be '**expr**' for a Server Side Expression operation. | |
| `model` | [interface{} ](#interface ) | `interface{}` | | | JSON is the raw JSON query and includes the above properties as well as custom properties. | |
| `queryType` | string | string | | | QueryType is an optional identifier for the type of query. It can be used to distinguish different types of queries. | |
| `refId` | string | string | | | RefID is the unique identifier of the query, set by the frontend call. | |
| `relativeTimeRange` | [RelativeTimeRange ](#relative-time-range ) | `RelativeTimeRange` | | | | |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
### <span id="alert-query-export"></span> AlertQueryExport
**Properties**
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Type | Go type | Required | Default | Description | Example |
| ------------------- | ----------------------------------------- | ------------------- | :------: | ------- | ----------- | ------- |
| `datasourceUid` | string | string | | | | |
| `model` | [interface{} ](#interface ) | `interface{}` | | | | |
| `queryType` | string | string | | | | |
| `refId` | string | string | | | | |
| `relativeTimeRange` | [RelativeTimeRange ](#relative-time-range ) | `RelativeTimeRange` | | | | |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
### <span id="alert-rule-export"></span> AlertRuleExport
**Properties**
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Type | Go type | Required | Default | Description | Example |
| -------------- | ----------------------------------------- | --------------------- | :------: | ------- | ----------- | ------- |
| `annotations` | map of string | `map[string]string` | | | | |
| `condition` | string | string | | | | |
| `dashboardUid` | string | string | | | | |
| `data` | [][AlertQueryExport](#alert-query-export) | `[]*AlertQueryExport` | | | | |
| `execErrState` | string | string | | | | |
| `for` | [Duration ](#duration ) | Duration | | | | |
| `isPaused` | boolean | `bool` | | | | |
| `labels` | map of string | `map[string]string` | | | | |
| `noDataState` | string | string | | | | |
| `panelId` | int64 (formatted integer) | int64 | | | | |
| `title` | string | string | | | | |
| `uid` | string | string | | | | |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
### <span id="alert-rule-group"></span> AlertRuleGroup
**Properties**
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Type | Go type | Required | Default | Description | Example |
| ----------- | ------------------------------------------------- | ------------------------- | :------: | ------- | ----------- | ------- |
| `folderUid` | string | string | | | | |
| `interval` | int64 (formatted integer) | int64 | | | | |
| `rules` | [][ProvisionedAlertRule](#provisioned-alert-rule) | `[]*ProvisionedAlertRule` | | | | |
| `title` | string | string | | | | |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
### <span id="alert-rule-group-export"></span> AlertRuleGroupExport
**Properties**
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Type | Go type | Required | Default | Description | Example |
| ---------- | --------------------------------------- | -------------------- | :------: | ------- | ----------- | ------- |
| `folder` | string | string | | | | |
| `interval` | [Duration ](#duration ) | Duration | | | | |
| `name` | string | string | | | | |
| `orgId` | int64 (formatted integer) | int64 | | | | |
| `rules` | [][AlertRuleExport](#alert-rule-export) | `[]*AlertRuleExport` | | | | |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
### <span id="alerting-file-export"></span> AlertingFileExport
**Properties**
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Type | Go type | Required | Default | Description | Example |
| --------------- | --------------------------------------------------------- | ----------------------------- | :------: | ------- | ----------- | ------- |
| `apiVersion` | int64 (formatted integer) | int64 | | | | |
| `contactPoints` | [][ContactPointExport](#contact-point-export) | `[]*ContactPointExport` | | | | |
| `groups` | [][AlertRuleGroupExport](#alert-rule-group-export) | `[]*AlertRuleGroupExport` | | | | |
| `policies` | [][NotificationPolicyExport](#notification-policy-export) | `[]*NotificationPolicyExport` | | | | |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
### <span id="contact-point-export"></span> ContactPointExport
**Properties**
2025-03-10 18:33:30 +08:00
| Name | Type | Go type | Required | Default | Description | Example |
| ----------- | ------------------------------------ | ------------------- | :------: | ------- | ----------- | ------- |
| `name` | string | string | | | | |
| `orgId` | int64 (formatted integer) | int64 | | | | |
| `receivers` | [][ReceiverExport](#receiver-export) | `[]*ReceiverExport` | | | | |
2024-02-12 17:27:18 +08:00
### <span id="contact-points"></span> ContactPoints
[][EmbeddedContactPoint](#embedded-contact-point)
### <span id="duration"></span> Duration
2025-03-10 18:33:30 +08:00
| Name | Type | Go type | Default | Description | Example |
| ---------- | ------ | ------- | ------- | ----------- | ------- |
| `Duration` | string | int64 | | | |
2024-02-12 17:27:18 +08:00
### <span id="embedded-contact-point"></span> EmbeddedContactPoint
2024-11-06 22:28:44 +08:00
EmbeddedContactPoint is the contact point type used by Grafana-managed alerts.
When creating a contact point, the `EmbeddedContactPoint.name` property determines if the new contact point is added to an existing one. In the UI, contact points with the same name are grouped together under a single contact point.
2024-02-12 17:27:18 +08:00
**Properties**
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Type | Go type | Required | Default | Description | Example |
| ----------------------- | ------------- | ------- | :------: | ------- | ---------------------------------------------------------------------------------- | ----------------------- |
| `disableResolveMessage` | boolean | `bool` | | | | false |
| `name` | string | string | | | `name` groups multiple contact points with the same name in the UI. | `webhook_1` |
| `provenance` | string | string | | | | |
| `settings` | [JSON ](#json ) | JSON | ✓ | | | |
| `type` | string | string | ✓ | | | `webhook` |
| `uid` | string | string | | | UID is the unique identifier of the contact point. The UID can be set by the user. | `my_external_reference` |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
### <span id="json"></span> Json
[interface{} ](#interface )
### <span id="match-regexps"></span> MatchRegexps
[MatchRegexps ](#match-regexps )
### <span id="match-type"></span> MatchType
2025-03-10 18:33:30 +08:00
| Name | Type | Go type | Default | Description | Example |
| ----------- | ------------------------- | ------- | ------- | ----------- | ------- |
| `MatchType` | int64 (formatted integer) | int64 | | | |
2024-02-12 17:27:18 +08:00
### <span id="matcher"></span> Matcher
**Properties**
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Type | Go type | Required | Default | Description | Example |
| ------- | ------------------------ | --------- | :------: | ------- | ----------- | ------- |
| `Name` | string | string | | | | |
| `Type` | [MatchType ](#match-type ) | MatchType | | | | |
| `Value` | string | string | | | | |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
### <span id="matchers"></span> Matchers
> Matchers is a slice of Matchers that is sortable, implements Stringer, and
> provides a Matches method to match a LabelSet against all Matchers in the
> slice. Note that some users of Matchers might require it to be sorted.
[][Matcher](#matcher)
### <span id="mute-time-interval"></span> MuteTimeInterval
**Properties**
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Type | Go type | Required | Default | Description | Example |
| ---------------- | -------------------------------- | ----------------- | :------: | ------- | ------------------- | ------- |
| `name` | string | string | | | | |
| `time_intervals` | [][TimeInterval](#time-interval) | `[]*TimeInterval` | | | | |
| `version` | string | string | | | Version of resource | |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
2024-03-04 17:50:44 +08:00
### <span id="mute-timing-export"></span> MuteTimingExport
**Properties**
### <span id="mute-timings-export"></span> MuteTimingsExport
**Properties**
2024-02-12 17:27:18 +08:00
### <span id="mute-timings"></span> MuteTimings
[][MuteTimeInterval](#mute-time-interval)
### <span id="not-found"></span> NotFound
[interface{} ](#interface )
### <span id="notification-policy-export"></span> NotificationPolicyExport
**Properties**
2025-03-10 18:33:30 +08:00
| Name | Type | Go type | Required | Default | Description | Example |
| -------- | ---------------------------- | ---------------------------- | :------: | ------- | ----------- | ------- |
| `Policy` | [RouteExport ](#route-export ) | [RouteExport ](#route-export ) | | | inline | |
| `orgId` | int64 (formatted integer) | int64 | | | | |
2024-02-12 17:27:18 +08:00
### <span id="notification-template"></span> NotificationTemplate
**Properties**
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Type | Go type | Required | Default | Description | Example |
| ------------ | ------------------------- | ------------------------- | :------: | ------- | ------------------- | ------- |
| `name` | string | string | | | | |
| `provenance` | [Provenance ](#provenance ) | [Provenance ](#provenance ) | | | | |
| `template` | string | string | | | | |
| `version` | string | string | | | Version of resource | |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
### <span id="notification-template-content"></span> NotificationTemplateContent
**Properties**
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Type | Go type | Required | Default | Description | Example |
| ---------- | ------ | ------- | :------: | ------- | ------------------------------------------------------- | ------- |
| `template` | string | string | | | | |
| `version` | string | string | | | Version of resource. Should be empty for new templates. | |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
### <span id="notification-templates"></span> NotificationTemplates
[][NotificationTemplate](#notification-template)
### <span id="object-matchers"></span> ObjectMatchers
[Matchers ](#matchers )
#### Inlined models
### <span id="permission-denied"></span> PermissionDenied
[interface{} ](#interface )
### <span id="provenance"></span> Provenance
2025-03-10 18:33:30 +08:00
| Name | Type | Go type | Default | Description | Example |
| ------------ | ------ | ------- | ------- | ----------- | ------- |
| `Provenance` | string | string | | | |
2024-02-12 17:27:18 +08:00
### <span id="provisioned-alert-rule"></span> ProvisionedAlertRule
**Properties**
{{% responsive-table %}}
2025-04-08 13:09:48 +08:00
| Name | Type | Go type | Required | Default | Description | Example |
| ------------- | ---------------------------- | ------------------------- | :------: | ------- | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `annotations` | map of string | `map[string]string` | | | Optional key-value pairs. `__dashboardUid__` and `__panelId__` must be set together; one cannot be set without the other. | `{"runbook_url":"https://supercoolrunbook.com/page/13"}` |
| `condition` | string | string | ✓ | | | `A` |
| `data` | [][AlertQuery](#alert-query) | `[]*AlertQuery` | ✓ | | | `[{"datasourceUid":"__expr__","model":{"conditions":[{"evaluator":{"params":[0,0],"type":"gt"},"operator":{"type":"and"},"query":{"params":[]},"reducer":{"params":[],"type":"avg"},"type":"query"}],"datasource":{"type":"__expr__","uid":"__expr__"},"expression":"1 == 1","hide":false,"intervalMs":1000,"maxDataPoints":43200,"refId":"A","type":"math"},"queryType":"","refId":"A","relativeTimeRange":{"from":0,"to":0}}]` |
| execErrState | string | string | ✓ | | | |
| `folderUID` | string | string | ✓ | | | `project_x` |
| `for` | [Duration ](#duration ) | [Duration ](#duration ) | ✓ | | | |
| `id` | int64 (formatted integer) | int64 | | | | |
| `isPaused` | boolean | `bool` | | | | `false` |
| `labels` | map of string | `map[string]string` | | | | `{"team":"sre-team-1"}` |
| `noDataState` | string | string | ✓ | | | |
| `orgID` | int64 (formatted integer) | `int64 | ✓ | | | |
| `provenance` | [Provenance ](#provenance ) | [Provenance ](#provenance ) | | | | |
| `ruleGroup` | string | string | ✓ | | | `eval_group_1` |
| `title` | string | string | ✓ | | | `Always firing` |
| `uid` | string | string | | | | |
| `updated` | date-time (formatted string) | `strfmt.DateTime` | | | | |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
### <span id="provisioned-alert-rules"></span> ProvisionedAlertRules
[][ProvisionedAlertRule](#provisioned-alert-rule)
### <span id="raw-message"></span> RawMessage
[interface{} ](#interface )
### <span id="receiver-export"></span> ReceiverExport
**Properties**
2025-03-10 18:33:30 +08:00
| Name | Type | Go type | Required | Default | Description | Example |
| ----------------------- | -------------------------- | ---------- | :------: | ------- | ----------- | ------- |
| `disableResolveMessage` | boolean | `bool` | | | | |
| `settings` | [RawMessage ](#raw-message ) | RawMessage | | | | |
| `type` | string | string | | | | |
| `uid` | string | string | | | | |
2024-02-12 17:27:18 +08:00
### <span id="regexp"></span> Regexp
> A Regexp is safe for concurrent use by multiple goroutines,
> except for configuration methods, such as Longest.
[interface{} ](#interface )
### <span id="relative-time-range"></span> RelativeTimeRange
> RelativeTimeRange is the per query start and end time
> for requests.
**Properties**
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Type | Go type | Required | Default | Description | Example |
| ------ | --------------------- | -------- | :------: | ------- | ----------- | ------- |
| `from` | [Duration ](#duration ) | Duration | | | | |
| `to` | [Duration ](#duration ) | Duration | | | | |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
### <span id="route"></span> Route
> A Route is a node that contains definitions of how to handle alerts. This is modified
> from the upstream alertmanager in that it adds the ObjectMatchers property.
**Properties**
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Type | Go type | Required | Default | Description | Example |
| --------------------- | ---------------------------------- | ------------------- | :------: | ------- | --------------------------------------- | ------- |
| `continue` | boolean | `bool` | | | | |
| `group_by` | []string | `[]string` | | | | |
| `group_interval` | string | string | | | | |
| `group_wait` | string | string | | | | |
| `match` | map of string | `map[string]string` | | | Deprecated. Remove before v1.0 release. | |
| `match_re` | [MatchRegexps ](#match-regexps ) | `MatchRegexps` | | | | |
| `matchers` | [Matchers ](#matchers ) | `Matchers` | | | | |
| `mute_time_intervals` | []string | `[]string` | | | | |
| `object_matchers` | [ObjectMatchers ](#object-matchers ) | `ObjectMatchers` | | | | |
| `provenance` | [Provenance ](#provenance ) | Provenance | | | | |
| `receiver` | string | string | | | | |
| `repeat_interval` | string | string | | | | |
| `routes` | [][Route](#route) | `[]*Route` | | | | |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
### <span id="route-export"></span> RouteExport
> RouteExport is the provisioned file export of definitions.Route. This is needed to hide fields that aren't usable in
> provisioning file format. An alternative would be to define a custom MarshalJSON and MarshalYAML that excludes them.
**Properties**
2025-03-10 18:33:30 +08:00
| Name | Type | Go type | Required | Default | Description | Example |
| --------------------- | ---------------------------------- | ------------------- | :------: | ------- | --------------------------------------- | ------- |
| `continue` | boolean | `bool` | | | | |
| `group_by` | []string | `[]string` | | | | |
| `group_interval` | string | string | | | | |
| `group_wait` | string | string | | | | |
| `match` | map of string | `map[string]string` | | | Deprecated. Remove before v1.0 release. | |
| `match_re` | [MatchRegexps ](#match-regexps ) | `MatchRegexps` | | | | |
| `matchers` | [Matchers ](#matchers ) | `Matchers` | | | | |
| `mute_time_intervals` | []string | `[]string` | | | | |
| `object_matchers` | [ObjectMatchers ](#object-matchers ) | `ObjectMatchers` | | | | |
| `receiver` | string | string | | | | |
| `repeat_interval` | string | string | | | | |
| `routes` | [][RouteExport](#route-export) | `[]*RouteExport` | | | | |
2024-02-12 17:27:18 +08:00
### <span id="time-interval"></span> TimeInterval
> TimeInterval describes intervals of time. ContainsTime will tell you if a golang time is contained
> within the interval.
**Properties**
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Type | Go type | Required | Default | Description | Example |
| --------------- | -------------------------- | -------------- | :------: | ------- | ----------- | ------- |
| `days_of_month` | []string | []string | | | | |
| `location` | string | string | | | | |
| `months` | []string | []string | | | | |
| `times` | [][TimeRange](#time-range) | `[]*TimeRange` | | | | |
| `weekdays` | []string | []string | | | | |
| `years` | []string | []string | | | | |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
### <span id="time-range"></span> TimeRange
> For example, 4:00PM to End of the day would Begin at 1020 and End at 1440.
**Properties**
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Type | Go type | Required | Default | Description | Example |
| ------------ | ------ | ------- | :------: | ------- | ----------- | ----------------------- |
| `end_time` | string | string | | | | `"end_time": "24:00"` |
| `start_time` | string | string | | | | `"start_time": "18:00"` |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
### <span id="validation-error"></span> ValidationError
**Properties**
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Type | Go type | Required | Default | Description | Example |
| ----- | ------ | ------- | :------: | ------- | ----------- | --------------- |
| `msg` | string | string | | | | `error message` |
2024-02-12 17:27:18 +08:00
{{% /responsive-table %}}
2024-08-09 23:40:07 +08:00
### <span id="generic-public-error"></span> GenericPublicError
**Properties**
{{% responsive-table %}}
2025-03-10 18:33:30 +08:00
| Name | Type | Go type | Required | Default | Description | Example |
| ------------ | ---------- | ---------------- | :------: | ------- | ------------------------------------------------------------------------ | ------- |
| `statusCode` | string | string | ✓ | | HTTP Status Code | |
| `messageId` | string | string | ✓ | | Unique code of the error | |
| `message` | string | string | | | Error message | |
| `extra` | map of any | `map[string]any` | | | Extra information about the error. Format is specific to the error code. | |
2024-08-09 23:40:07 +08:00
{{% /responsive-table %}}
