v1

latestOpenAPI 3.0.32026-07-14314472448.6 KB
provisioning

Get a specific alert rule by UID.

get/v1/provisioning/alert-rules/{UID}

Path parameters

UIDstring required

Alert rule UID

Response

ProvisionedAlertRule

annotationsobject
conditionstring required
execErrState'OK' | 'Alerting' | 'Error' required
folderUIDstring required
forstring duration required
idinteger
isPausedboolean
keep_firing_forstring duration
labelsobject
missingSeriesEvalsToResolveinteger
noDataState'Alerting' | 'NoData' | 'OK' required
orgIDinteger required
provenancestring
ruleGroupstring required
titlestring required
uidstring
updatedstring date-time

Example response

{
  "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"
}