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 .
Grafana Cloud
Enterprise
Open source
Alerting provisioning HTTP API
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 .
For more information on the differences between Grafana-managed and data source-managed alerts, refer to
Introduction to alert rules .
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 .
Grafana-managed endpoints
Note that the JSON format from most of the following endpoints is not fully compatible with
provisioning via configuration JSON files .
Alert rules
Example request for new alert rule:
Expand code
POST /api/v1/provisioning/alert-rules
{
"title" : "TEST-API_1" ,
"ruleGroup" : "API" ,
"folderUID" : "SET_FOLDER_UID" ,
"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
} ,
"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"
}
}
]
} Example Response:
Expand code
HTTP/1.1 201 Created
{
"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
} Example Request for all the contact points:
GET /api/v1/provisioning/contact-points
Example Response:
HTTP/1.1 200 OK
[
{
"uid" : "" ,
"name" : "email receiver" ,
"type" : "email" ,
"settings" : {
"addresses" : "<example@email.com>"
} ,
"disableResolveMessage" : false
}
] Notification policies
Example Request for exporting the notification policy tree in YAML format:
GET /api/v1/provisioning/policies/export?format=yaml
Example Response:
HTTP/1.1 200 OK Mute timings
Example Request for all mute timings:
GET /api/v1/provisioning/mute-timings
Example Response:
HTTP/1.1 200 OK
[
{
"name" : "weekends" ,
"time_intervals" : [
{
"weekdays" : [
"saturday" ,
"sunday"
]
}
] ,
"version" : "" ,
"provenance" : "file"
}
] Templates
Example Request for all notification templates:
GET /api/v1/provisioning/templates
Example Response:
HTTP/1.1 200 OK
[
{
"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 }}" ,
"provenance" : "file"
}
] Edit resources in the Grafana UI
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 header to the following requests in the API:
POST /api/v1/provisioning/alert-rulesPUT /api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group} (calling this endpoint will change provenance for all alert rules within the alert group)POST /api/v1/provisioning/contact-pointsPOST /api/v1/provisioning/mute-timingsPUT /api/v1/provisioning/policiesPUT /api/v1/provisioning/templates/{name}To reset the notification policy tree to the default and unlock it for editing in the Grafana UI, use the DELETE /api/v1/provisioning/policies endpoint.
Data source-managed resources
The Alerting Provisioning HTTP API can only be used to manage Grafana-managed alert resources. To manage resources related to
data source-managed alerts , consider the following tools:
mimirtool : to interact with the Mimir alertmanager and ruler configuration.cortex-tools : to interact with the Cortex alertmanager and ruler configuration.lokitool : to configure the Loki Ruler.Alternatively, the
Grafana Alerting API 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 .
Paths
RouteDeleteAlertRule )
DELETE /api/v1/provisioning/alert-rules/:uidParameters
Expand table
Name Source Type Go type Separator Required Default Description UID pathstring string✓ Alert rule UID X-Disable-Provenance: true 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/:uidParameters
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/:nameParameters
Expand table
Name Source Type Go type Separator Required Default Description name pathstring string✓ Mute timing name version querystring stringCurrent version of the resource. Used for optimistic concurrency validation. Keep empty to bypass validation.
All responses
Expand table
Code Status Description Has headers Schema 204 No Content The mute timing was deleted successfully. schema 409 Conflict GenericPublicError schema
Responses
Status: No Content
Status: Conflict
GenericPublicError
RouteDeleteTemplate )
DELETE /api/v1/provisioning/templates/:nameParameters
Expand table
Name Source Type Go type Separator Required Default Description name pathstring string✓ Template Name version querystring stringCurrent version of the resource. Used for optimistic concurrency validation. Keep empty to bypass validation.
All responses
Expand table
Code Status Description Has headers Schema 204 No Content The template was deleted successfully. schema 409 Conflict GenericPublicError schema
Responses
Status: No Content
Status: Conflict
GenericPublicError
RouteGetAlertRule )
GET /api/v1/provisioning/alert-rules/:uidParameters
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 application/terraform+hcl text/yaml text/hcl 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 querystring 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.
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/:groupParameters
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 application/terraform+hcl text/yaml text/hcl 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 querystring 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.
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/exportProduces
application/json application/yaml application/terraform+hcl text/yaml text/hcl Parameters
Expand table
Name Source Type Go type Separator Required Default Description download queryboolean boolWhether to initiate a download of the file or not. format querystring 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.
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
GET /api/v1/provisioning/contact-points/exportProduces
application/json application/yaml application/terraform+hcl text/yaml text/hcl Parameters
Expand table
Name Source Type Go type Separator Required Default Description decrypt queryboolean boolWhether 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 queryboolean boolWhether to initiate a download of the file or not. format querystring 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 querystring stringFilter by name
All responses
Expand table
Code Status Description Has headers Schema 200 OK AlertingFileExport schema 403 Forbidden PermissionDenied schema
Responses
Status: OK
AlertingFileExport
Status: Forbidden
PermissionDenied
RouteGetMuteTiming )
GET /api/v1/provisioning/mute-timings/:nameParameters
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
GET /api/v1/provisioning/mute-timings/exportProduces
application/json application/yaml application/terraform+hcl text/yaml text/hcl Parameters
Expand table
Name Source Type Go type Separator Required Default Description download queryboolean boolWhether to initiate a download of the file or not. format querystring 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.
All responses
Expand table
Code Status Description Has headers Schema 200 OK MuteTimingsExport schema 403 Forbidden PermissionDenied schema
Responses
Status: OK
AlertingFileExport
Status: Forbidden
PermissionDenied
GET /api/v1/provisioning/mute-timings/:name/exportProduces
application/json application/yaml application/terraform+hcl text/yaml text/hcl Parameters
Expand table
Name Source Type Go type Separator Required Default Description name pathstring string✓ Mute timing name. download queryboolean boolWhether to initiate a download of the file or not. format querystring 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.
All responses
Expand table
Code Status Description Has headers Schema 200 OK MuteTimingExport schema 403 Forbidden PermissionDenied schema
Responses
Status: OK
AlertingFileExport
Status: Forbidden
PermissionDenied
RouteGetPolicyTree )
GET /api/v1/provisioning/policiesAll responses
Expand table
Code Status Description Has headers Schema 200 OK Route schema
Responses
Status: OK
Route
GET /api/v1/provisioning/policies/exportProduces
application/json application/yaml application/terraform+hcl text/yaml text/hcl Parameters
Expand table
Name Source Type Go type Separator Required Default Description download queryboolean boolWhether to initiate a download of the file or not. format querystring 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.
All responses
Expand table
Code Status Description Has headers Schema 200 OK AlertingFileExport schema 404 Not Found NotFound schema
Responses
Status: OK
AlertingFileExport
Status: Not Found
NotFound
RouteGetTemplate )
GET /api/v1/provisioning/templates/:nameParameters
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 GenericPublicError schema
Responses
Status: OK
NotificationTemplate
GenericPublicError
RouteGetTemplates )
GET /api/v1/provisioning/templatesAll responses
Expand table
Code Status Description Has headers Schema 200 OK NotificationTemplates schema
Responses
Status: OK
NotificationTemplates
RoutePostAlertRule )
POST /api/v1/provisioning/alert-rulesParameters
Expand table
Name Source Type Go type Separator Required Default Description X-Disable-Provenance: true 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-pointsWhen 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.
Parameters
Expand table
Name Source Type Go type Separator Required Default Description X-Disable-Provenance: true 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-timingsParameters
Expand table
Name Source Type Go type Separator Required Default Description X-Disable-Provenance: true 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/:uidParameters
Expand table
Name Source Type Go type Separator Required Default Description UID pathstring string✓ Alert rule UID X-Disable-Provenance: true 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/:groupParameters
Expand table
Name Source Type Go type Separator Required Default Description FolderUID pathstring string✓ Group pathstring string✓ X-Disable-Provenance: true headerstring stringAllows editing of provisioned resources in the Grafana UI Body bodyAlertRuleGroup models.AlertRuleGroupThis action is idempotent and rules included in this body will overwrite configured rules for the group
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/:uidParameters
Expand table
Name Source Type Go type Separator Required Default Description UID pathstring string✓ UID is the contact point unique identifier X-Disable-Provenance: true 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/:nameParameters
Expand table
Name Source Type Go type Separator Required Default Description name pathstring string✓ Mute timing name X-Disable-Provenance: true 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 409 Conflict GenericPublicError schema
Responses
Status: OK
MuteTimeInterval
Status: Bad Request
ValidationError
Status: Conflict
GenericPublicError
RoutePutPolicyTree )
PUT /api/v1/provisioning/policiesParameters
Expand table
Name Source Type Go type Separator Required Default Description X-Disable-Provenance: true 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/:nameParameters
Expand table
Name Source Type Go type Separator Required Default Description name pathstring string✓ Template Name X-Disable-Provenance: true 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 GenericPublicError schema 409 Conflict GenericPublicError schema
Responses
Status: Accepted
NotificationTemplate
Status: Bad Request
GenericPublicError
Status: Conflict
GenericPublicError
RouteResetPolicyTree )
DELETE /api/v1/provisioning/policiesAll 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 stringdashboardUid string stringdata []
AlertQueryExport []*AlertQueryExportexecErrState string stringfor Duration DurationisPaused boolean boollabels 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
Properties
Expand table
Name Type Go type Required Default Description Example name string stringorgId int64 (formatted integer) int64receivers []
ReceiverExport []*ReceiverExport
[]
EmbeddedContactPoint
Expand table
Name Type Go type Default Description Example Duration string int64
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.
Properties
Expand table
Name Type Go type Required Default Description Example disableResolveMessage boolean boolfalsename string stringname groups multiple contact points with the same name 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 []*TimeIntervalversion string stringVersion of resource
Properties
Properties
[]
MuteTimeInterval
interface{}
Properties
Expand table
Name Type Go type Required Default Description Example Policy RouteExport RouteExportinline orgId int64 (formatted integer) int64
Properties
Expand table
Name Type Go type Required Default Description Example name string stringprovenance Provenance Provenancetemplate string stringversion string stringVersion of resource
Properties
Expand table
Name Type Go type Required Default Description Example template string stringversion string stringVersion of resource. Should be empty for new templates.
[]
NotificationTemplate
Matchers
Inlined models
interface{}
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]stringOptional 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✓ 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) int64isPaused boolean boolfalselabels 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
interface{}
Properties
Expand table
Name Type Go type Required Default Description Example disableResolveMessage boolean boolsettings RawMessage RawMessagetype string stringuid string string
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
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
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 ObjectMatchersreceiver string stringrepeat_interval string stringroutes []
RouteExport []*RouteExport
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 end_time string string"end_time": "24:00"start_time string string"start_time": "18:00"
Properties
Expand table
Name Type Go type Required Default Description Example msg string stringerror message
Properties
Expand table
Name Type Go type Required Default Description Example statusCode string string✓ HTTP Status Code messageId string string✓ Unique code of the error message string stringError message extra map of any map[string]anyExtra information about the error. Format is specific to the error code.
