v1

latestOpenAPI 3.0.32026-07-14314472448.6 KB
provisioning

Create or update alert rule group.

put/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}

Path parameters

FolderUIDstring required
Groupstring required

Headers

X-Disable-Provenancestring

Request body

folderUidstring
intervalinteger
titlestring

Example request

{
  "rules": [
    {
      "annotations": {
        "runbook_url": "https://supercoolrunbook.com/page/13"
      },
      "condition": "A",
      "data": [
        {
          "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
          }
        }
      ],
      "folderUID": "project_x",
      "labels": {
        "team": "sre-team-1"
      },
      "missingSeriesEvalsToResolve": 2,
      "notification_settings": {
        "active_time_intervals": [
          "maintenance"
        ],
        "group_by": [
          "alertname",
          "grafana_folder",
          "cluster"
        ],
        "group_interval": "5m",
        "group_wait": "30s",
        "mute_time_intervals": [
          "maintenance"
        ],
        "receiver": "grafana-default-email",
        "repeat_interval": "4h"
      },
      "record": {
        "from": "A",
        "metric": "grafana_alerts_ratio",
        "target_datasource_uid": "my-prom"
      },
      "ruleGroup": "eval_group_1",
      "title": "Always firing"
    }
  ]
}

Response

AlertRuleGroup

folderUidstring
intervalinteger
titlestring

Example response

{
  "rules": [
    {
      "annotations": {
        "runbook_url": "https://supercoolrunbook.com/page/13"
      },
      "condition": "A",
      "data": [
        {
          "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
          }
        }
      ],
      "folderUID": "project_x",
      "labels": {
        "team": "sre-team-1"
      },
      "missingSeriesEvalsToResolve": 2,
      "notification_settings": {
        "active_time_intervals": [
          "maintenance"
        ],
        "group_by": [
          "alertname",
          "grafana_folder",
          "cluster"
        ],
        "group_interval": "5m",
        "group_wait": "30s",
        "mute_time_intervals": [
          "maintenance"
        ],
        "receiver": "grafana-default-email",
        "repeat_interval": "4h"
      },
      "record": {
        "from": "A",
        "metric": "grafana_alerts_ratio",
        "target_datasource_uid": "my-prom"
      },
      "ruleGroup": "eval_group_1",
      "title": "Always firing"
    }
  ]
}