Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version .
Alerting provisioning HTTP API
Version
1.1.0
Content negotiation
Consumes
Produces
application/json text/yaml application/yaml All endpoints
Alert rules
Note:
Contact point provisioning is for Grafana-managed alerts only.
Notification policies
Mute timings
Templates
Paths
RouteDeleteAlertRule )
DELETE /api/v1/provisioning/alert-rules/{UID}Parameters
Expand table
Name Source Type Go type Separator Required Default Description UID pathstring string✓ Alert rule UID X-Disable-Provenance headerstring stringAllows editing of provisioned resources in the Grafana UI
All responses
Expand table
Code Status Description Has headers Schema 204 No Content The alert rule was deleted successfully. schema
Responses
Status: No Content
DELETE /api/v1/provisioning/contact-points/{UID}Consumes
Parameters
Expand table
Name Source Type Go type Separator Required Default Description UID pathstring string✓ UID is the contact point unique identifier
All responses
Expand table
Code Status Description Has headers Schema 204 No Content The contact point was deleted successfully. schema
Responses
Status: No Content
RouteDeleteMuteTiming )
DELETE /api/v1/provisioning/mute-timings/{name}Parameters
Expand table
Name Source Type Go type Separator Required Default Description name pathstring string✓ Mute timing name
All responses
Expand table
Code Status Description Has headers Schema 204 No Content The mute timing was deleted successfully. schema
Responses
Status: No Content
RouteDeleteTemplate )
DELETE /api/v1/provisioning/templates/{name}Parameters
Expand table
Name Source Type Go type Separator Required Default Description name pathstring string✓ Template Name
All responses
Expand table
Code Status Description Has headers Schema 204 No Content The template was deleted successfully. schema
Responses
Status: No Content
RouteGetAlertRule )
GET /api/v1/provisioning/alert-rules/{UID}Parameters
Expand table
Name Source Type Go type Separator Required Default Description UID pathstring string✓ Alert rule UID
All responses
Expand table
Code Status Description Has headers Schema 200 OK ProvisionedAlertRule schema 404 Not Found Not found. schema
Responses
Status: OK
ProvisionedAlertRule
Status: Not Found
GET /api/v1/provisioning/alert-rules/{UID}/exportProduces
application/json application/yaml text/yaml Parameters
Expand table
Name Source Type Go type Separator Required Default Description UID pathstring string✓ Alert rule UID download queryboolean boolWhether to initiate a download of the file or not. format querystringstring "yaml"Format of the downloaded file, either yaml or json. Accept header can also be used, but the query parameter will take precedence.
All responses
Expand table
Code Status Description Has headers Schema 200 OK AlertingFileExport schema 404 Not Found Not found. schema
Responses
Status: OK
AlertingFileExport
Status: Not Found
RouteGetAlertRuleGroup )
GET /api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}Parameters
Expand table
Name Source Type Go type Separator Required Default Description FolderUID pathstring string✓ Group pathstring string✓
All responses
Expand table
Code Status Description Has headers Schema 200 OK AlertRuleGroup schema 404 Not Found Not found. schema
Responses
Status: OK
AlertRuleGroup
Status: Not Found
GET /api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}/exportProduces
application/json application/yaml text/yaml Parameters
Expand table
Name Source Type Go type Separator Required Default Description FolderUID pathstring string✓ Group pathstring string✓ download queryboolean boolWhether to initiate a download of the file or not. format querystringstring "yaml"Format of the downloaded file, either yaml or json. Accept header can also be used, but the query parameter will take precedence.
All responses
Expand table
Code Status Description Has headers Schema 200 OK AlertingFileExport schema 404 Not Found Not found. schema
Responses
Status: OK
AlertingFileExport
Status: Not Found
RouteGetAlertRules )
GET /api/v1/provisioning/alert-rulesAll responses
Expand table
Code Status Description Has headers Schema 200 OK ProvisionedAlertRules schema
Responses
Status: OK
ProvisionedAlertRules
GET /api/v1/provisioning/alert-rules/exportParameters
Expand table
Name Source Type Go type Separator Required Default Description download queryboolean boolWhether to initiate a download of the file or not. format querystringstring "yaml"Format of the downloaded file, either yaml or json. Accept header can also be used, but the query parameter will take precedence.
All responses
Expand table
Code Status Description Has headers Schema 200 OK AlertingFileExport schema 404 Not Found Not found. schema
Responses
Status: OK
AlertingFileExport
Status: Not Found
GET /api/v1/provisioning/contact-pointsParameters
Expand table
Name Source Type Go type Separator Required Default Description name querystring stringFilter by name
All responses
Expand table
Code Status Description Has headers Schema 200 OK ContactPoints schema
Responses
Status: OK
ContactPoints
RouteGetMuteTiming )
GET /api/v1/provisioning/mute-timings/{name}Parameters
Expand table
Name Source Type Go type Separator Required Default Description name pathstring string✓ Mute timing name
All responses
Expand table
Code Status Description Has headers Schema 200 OK MuteTimeInterval schema 404 Not Found Not found. schema
Responses
Status: OK
MuteTimeInterval
Status: Not Found
RouteGetMuteTimings )
GET /api/v1/provisioning/mute-timingsAll responses
Expand table
Code Status Description Has headers Schema 200 OK MuteTimings schema
Responses
Status: OK
MuteTimings
RouteGetPolicyTree )
GET /api/v1/provisioning/policiesAll responses
Expand table
Code Status Description Has headers Schema 200 OK Route schema
Responses
Status: OK
Route
RouteGetTemplate )
GET /api/v1/provisioning/templates/{name}Parameters
Expand table
Name Source Type Go type Separator Required Default Description name pathstring string✓ Template Name
All responses
Expand table
Code Status Description Has headers Schema 200 OK NotificationTemplate schema 404 Not Found Not found. schema
Responses
Status: OK
NotificationTemplate
Status: Not Found
RouteGetTemplates )
GET /api/v1/provisioning/templatesAll responses
Expand table
Code Status Description Has headers Schema 200 OK NotificationTemplates schema 404 Not Found Not found. schema
Responses
Status: OK
NotificationTemplates
Status: Not Found
RoutePostAlertRule )
POST /api/v1/provisioning/alert-rulesConsumes
Parameters
Expand table
Name Source Type Go type Separator Required Default Description X-Disable-Provenance headerstring stringAllows editing of provisioned resources in the Grafana UI Body bodyProvisionedAlertRule models.ProvisionedAlertRule
All responses
Expand table
Code Status Description Has headers Schema 201 Created ProvisionedAlertRule schema 400 Bad Request ValidationError schema
Responses
Status: Created
ProvisionedAlertRule
Status: Bad Request
ValidationError
RoutePostContactpoints )
POST /api/v1/provisioning/contact-pointsConsumes
Parameters
Expand table
Name Source Type Go type Separator Required Default Description X-Disable-Provenance headerstring stringAllows editing of provisioned resources in the Grafana UI Body bodyEmbeddedContactPoint models.EmbeddedContactPoint
All responses
Expand table
Code Status Description Has headers Schema 202 Accepted EmbeddedContactPoint schema 400 Bad Request ValidationError schema
Responses
Status: Accepted
EmbeddedContactPoint
Status: Bad Request
ValidationError
RoutePostMuteTiming )
POST /api/v1/provisioning/mute-timingsConsumes
Parameters
Expand table
Name Source Type Go type Separator Required Default Description X-Disable-Provenance headerstring stringAllows editing of provisioned resources in the Grafana UI Body bodyMuteTimeInterval models.MuteTimeInterval
All responses
Expand table
Code Status Description Has headers Schema 201 Created MuteTimeInterval schema 400 Bad Request ValidationError schema
Responses
Status: Created
MuteTimeInterval
Status: Bad Request
ValidationError
RoutePutAlertRule )
PUT /api/v1/provisioning/alert-rules/{UID}Consumes
Parameters
Expand table
Name Source Type Go type Separator Required Default Description UID pathstring string✓ Alert rule UID X-Disable-Provenance headerstring stringAllows editing of provisioned resources in the Grafana UI Body bodyProvisionedAlertRule models.ProvisionedAlertRule
All responses
Expand table
Code Status Description Has headers Schema 200 OK ProvisionedAlertRule schema 400 Bad Request ValidationError schema
Responses
Status: OK
ProvisionedAlertRule
Status: Bad Request
ValidationError
RoutePutAlertRuleGroup )
PUT /api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}Consumes
Parameters
Expand table
Name Source Type Go type Separator Required Default Description FolderUID pathstring string✓ Group pathstring string✓ X-Disable-Provenance headerstring stringAllows editing of provisioned resources in the Grafana UI Body bodyAlertRuleGroup models.AlertRuleGroup
All responses
Expand table
Code Status Description Has headers Schema 200 OK AlertRuleGroup schema 400 Bad Request ValidationError schema
Responses
Status: OK
AlertRuleGroup
Status: Bad Request
ValidationError
PUT /api/v1/provisioning/contact-points/{UID}Consumes
Parameters
Expand table
Name Source Type Go type Separator Required Default Description UID pathstring string✓ UID is the contact point unique identifier X-Disable-Provenance headerstring stringAllows editing of provisioned resources in the Grafana UI Body bodyEmbeddedContactPoint models.EmbeddedContactPoint
All responses
Expand table
Code Status Description Has headers Schema 202 Accepted Ack schema 400 Bad Request ValidationError schema
Responses
Status: Accepted
Ack
Status: Bad Request
ValidationError
RoutePutMuteTiming )
PUT /api/v1/provisioning/mute-timings/{name}Consumes
Parameters
Expand table
Name Source Type Go type Separator Required Default Description name pathstring string✓ Mute timing name X-Disable-Provenance headerstring stringAllows editing of provisioned resources in the Grafana UI Body bodyMuteTimeInterval models.MuteTimeInterval
All responses
Expand table
Code Status Description Has headers Schema 200 OK MuteTimeInterval schema 400 Bad Request ValidationError schema
Responses
Status: OK
MuteTimeInterval
Status: Bad Request
ValidationError
RoutePutPolicyTree )
PUT /api/v1/provisioning/policiesConsumes
Parameters
Expand table
Name Source Type Go type Separator Required Default Description X-Disable-Provenance headerstring stringAllows editing of provisioned resources in the Grafana UI Body bodyRoute models.RouteThe new notification routing tree to use
All responses
Expand table
Code Status Description Has headers Schema 202 Accepted Ack schema 400 Bad Request ValidationError schema
Responses
Status: Accepted
Ack
Status: Bad Request
ValidationError
RoutePutTemplate )
PUT /api/v1/provisioning/templates/{name}Consumes
Parameters
Expand table
Name Source Type Go type Separator Required Default Description name pathstring string✓ Template Name X-Disable-Provenance headerstring stringAllows editing of provisioned resources in the Grafana UI Body bodyNotificationTemplateContent models.NotificationTemplateContent
All responses
Expand table
Code Status Description Has headers Schema 202 Accepted NotificationTemplate schema 400 Bad Request ValidationError schema
Responses
Status: Accepted
NotificationTemplate
Status: Bad Request
ValidationError
RouteResetPolicyTree )
DELETE /api/v1/provisioning/policiesConsumes
All responses
Expand table
Code Status Description Has headers Schema 202 Accepted Ack schema
Responses
Status: Accepted
Ack
Models
interface{}
Properties
Expand table
Name Type Go type Required Default Description Example datasourceUid string stringGrafana data source unique identifier; it should be ‘expr ’ for a Server Side Expression operation. model interface{} interface{}JSON is the raw JSON query and includes the above properties as well as custom properties. queryType string stringQueryType is an optional identifier for the type of query. It can be used to distinguish different types of queries. refId string stringRefID is the unique identifier of the query, set by the frontend call. relativeTimeRange RelativeTimeRange RelativeTimeRange
Properties
Expand table
Name Type Go type Required Default Description Example datasourceUid string stringmodel interface{} interface{}queryType string stringrefId string stringrelativeTimeRange RelativeTimeRange RelativeTimeRange
Properties
Expand table
Name Type Go type Required Default Description Example annotations map of string map[string]stringcondition string stringdasboardUid string stringdata []alertqueryexport []*AlertQueryExportexecErrState string stringfor Duration Durationlabels map of string map[string]stringnoDataState string stringpanelId int64 (formatted integer) int64title string stringuid string string
Properties
Expand table
Name Type Go type Required Default Description Example folderUid string stringinterval int64 (formatted integer) int64rules []provisionedalertrule []*ProvisionedAlertRuletitle string string
Properties
Expand table
Name Type Go type Required Default Description Example folder string stringinterval Duration Durationname string stringorgId int64 (formatted integer) int64rules []alertruleexport []*AlertRuleExport
Properties
Expand table
Name Type Go type Required Default Description Example apiVersion int64 (formatted integer) int64groups []alertrulegroupexport []*AlertRuleGroupExport
[]embeddedcontactpoint
Expand table
Name Type Go type Default Description Example Duration int64 (formatted integer) int64
EmbeddedContactPoint is the contact point type that is used
by grafanas embedded alertmanager implementation.
Properties
Expand table
Name Type Go type Required Default Description Example disableResolveMessage boolean boolfalsename string stringName is used as grouping key in the UI. Contact points with the same name will be grouped in the UI. webhook_1provenance string stringsettings JSON JSON✓ type string string✓ webhookuid string stringUID is the unique identifier of the contact point. The UID can be set by the user. my_external_reference
interface{}
MatchRegexps
Expand table
Name Type Go type Default Description Example MatchType int64 (formatted integer) int64
Properties
Expand table
Name Type Go type Required Default Description Example Name string stringType MatchType MatchTypeValue string string
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
Properties
Expand table
Name Type Go type Required Default Description Example name string stringtime_intervals []timeinterval []*TimeInterval
[]mutetimeinterval
Properties
Expand table
Name Type Go type Required Default Description Example name string stringprovenance Provenance Provenancetemplate string string
Properties
Expand table
Name Type Go type Required Default Description Example template string string
[]notificationtemplate
Matchers
Inlined models
Expand table
Name Type Go type Default Description Example Provenance string string
Properties
Expand table
Name Type Go type Required Default Description Example annotations map of string map[string]string{"runbook_url":"https://supercoolrunbook.com/page/13"}condition string string✓ Adata []alertquery []*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_xfor Duration Duration✓ id int64 (formatted integer) int64labels map of string map[string]string{"team":"sre-team-1"}noDataState string string✓ orgID int64 (formatted integer) int64✓ provenance Provenance ProvenanceruleGroup string string✓ eval_group_1title string string✓ Always firinguid string stringupdated date-time (formatted string) strfmt.DateTime
[]provisionedalertrule
A Regexp is safe for concurrent use by multiple goroutines,
except for configuration methods, such as Longest.
interface{}
RelativeTimeRange is the per query start and end time
for requests.
Properties
Expand table
Name Type Go type Required Default Description Example from Duration Durationto Duration Duration
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
Expand table
Name Type Go type Required Default Description Example continue boolean boolgroup_by []string []stringgroup_interval string stringgroup_wait string stringmatch map of string map[string]stringDeprecated. Remove before v1.0 release. match_re MatchRegexps MatchRegexpsmatchers Matchers Matchersmute_time_intervals []string []stringobject_matchers ObjectMatchers ObjectMatchersprovenance Provenance Provenancereceiver string stringrepeat_interval string stringroutes []route []*Route
TimeInterval describes intervals of time. ContainsTime will tell you if a golang time is contained
within the interval.
Properties
Expand table
Name Type Go type Required Default Description Example days_of_month []string []stringlocation string stringmonths []string []stringtimes []timerange []*TimeRangeweekdays []string []stringyears []string []string
For example, 4:00PM to End of the day would Begin at 1020 and End at 1440.
Properties
Expand table
Name Type Go type Required Default Description Example EndMinute int64 (formatted integer) int64StartMinute int64 (formatted integer) int64
Properties
Expand table
Name Type Go type Required Default Description Example msg string stringerror message
