Provision Alerting resources on Grafana Labs

Delete a notification template group. (RouteDeleteTemplate)

DELETE /api/v1/provisioning/templates/:name

Parameters

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.

All responses

Code	Status	Description	Has headers	Schema
204	No Content	The template was deleted successfully.		schema
409	Conflict	GenericPublicError		schema

Responses

204 - The template was deleted successfully.

Status: No Content

Schema

409 - Conflict

Status: Conflict

Schema

Get a specific alert rule by UID. (RouteGetAlertRule)

GET /api/v1/provisioning/alert-rules/:uid

Parameters

Name	Source	Type	Go type	Required	Default	Description
`UID`	path	string	string	✓		Alert rule UID

All responses

Code	Status	Description	Has headers	Schema
200	OK	ProvisionedAlertRule		schema
404	Not Found	Not found.		schema

Responses

200 - ProvisionedAlertRule

Status: OK

Schema

ProvisionedAlertRule

404 - Not found.

Status: Not Found

Schema

Export an alert rule in provisioning file format. (RouteGetAlertRuleExport)

GET /api/v1/provisioning/alert-rules/:uid/export

Produces

application/json
application/yaml
application/terraform+hcl
text/yaml
text/hcl

These outputs are for file provisioning or Terraform provisioning, and they-including the JSON output—cannot be used to update resources via the HTTP API.

Parameters

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.

All responses

Code	Status	Description	Has headers	Schema
200	OK	AlertingFileExport		schema
404	Not Found	Not found.		schema

Responses

200 - AlertingFileExport

Status: OK

Schema

404 - Not found.

Status: Not Found

Schema

Get a rule group. (RouteGetAlertRuleGroup)

GET /api/v1/provisioning/folder/:folderUid/rule-groups/:group

Parameters

Name	Source	Type	Go type	Required	Default	Description
`FolderUID`	path	string	string	✓
`Group`	path	string	string	✓

All responses

Code	Status	Description	Has headers	Schema
200	OK	AlertRuleGroup		schema
404	Not Found	Not found.		schema

Responses

200 - AlertRuleGroup

Status: OK

Schema

AlertRuleGroup

404 - Not found.

Status: Not Found

Schema

Export an alert rule group in provisioning file format. (RouteGetAlertRuleGroupExport)

GET /api/v1/provisioning/folder/:folderUid/rule-groups/:group/export

Produces

application/json
application/yaml
application/terraform+hcl
text/yaml
text/hcl

These outputs are for file provisioning or Terraform provisioning, and they-including the JSON output—cannot be used to update resources via the HTTP API.

Parameters

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.

All responses

Code	Status	Description	Has headers	Schema
200	OK	AlertingFileExport		schema
404	Not Found	Not found.		schema

Responses

200 - AlertingFileExport

Status: OK

Schema

404 - Not found.

Status: Not Found

Schema

Get all the alert rules. (RouteGetAlertRules)

GET /api/v1/provisioning/alert-rules

All responses

Code	Status	Description	Has headers	Schema
200	OK	ProvisionedAlertRules		schema

Responses

200 - ProvisionedAlertRules

Status: OK

Schema

ProvisionedAlertRules

Export all alert rules in provisioning file format. (RouteGetAlertRulesExport)

GET /api/v1/provisioning/alert-rules/export

Produces

application/json
application/yaml
application/terraform+hcl
text/yaml
text/hcl

These outputs are for file provisioning or Terraform provisioning, and they-including the JSON output—cannot be used to update resources via the HTTP API.

Parameters

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.

All responses

Code	Status	Description	Has headers	Schema
200	OK	AlertingFileExport		schema
404	Not Found	Not found.		schema

Responses

200 - AlertingFileExport

Status: OK

Schema

404 - Not found.

Status: Not Found

Schema

Get all the contact points. (RouteGetContactpoints)

GET /api/v1/provisioning/contact-points

Parameters

Name	Source	Type	Go type	Required	Default	Description
`name`	query	string	string			Filter by name

All responses

Code	Status	Description	Has headers	Schema
200	OK	ContactPoints		schema

Responses

200 - ContactPoints

Status: OK

Schema

ContactPoints

Export all contact points in provisioning file format. (RouteGetContactpointsExport)

GET /api/v1/provisioning/contact-points/export

Produces

application/json
application/yaml
application/terraform+hcl
text/yaml
text/hcl

These outputs are for file provisioning or Terraform provisioning, and they-including the JSON output—cannot be used to update resources via the HTTP API.

Parameters

Name	Source	Type	Go type	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

All responses

Code	Status	Description	Has headers	Schema
200	OK	AlertingFileExport		schema
403	Forbidden	PermissionDenied		schema

Responses

200 - AlertingFileExport

Status: OK

Schema

403 - PermissionDenied

Status: Forbidden

Schema

PermissionDenied

Get a mute timing. (RouteGetMuteTiming)

GET /api/v1/provisioning/mute-timings/:name

Parameters

Name	Source	Type	Go type	Required	Default	Description
`name`	path	string	string	✓		Mute timing name

All responses

Code	Status	Description	Has headers	Schema
200	OK	MuteTimeInterval		schema
404	Not Found	Not found.		schema

Responses

200 - MuteTimeInterval

Status: OK

Schema

MuteTimeInterval

404 - Not found.

Status: Not Found

Schema

Get all the mute timings. (RouteGetMuteTimings)

GET /api/v1/provisioning/mute-timings

All responses

Code	Status	Description	Has headers	Schema
200	OK	MuteTimings		schema

Responses

200 - MuteTimings

Status: OK

Schema

MuteTimings

Export all mute timings in provisioning file format. (RouteGetMuteTimingsExport)

GET /api/v1/provisioning/mute-timings/export

Produces

application/json
application/yaml
application/terraform+hcl
text/yaml
text/hcl

These outputs are for file provisioning or Terraform provisioning, and they-including the JSON output—cannot be used to update resources via the HTTP API.

Parameters

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.

All responses

Code	Status	Description	Has headers	Schema
200	OK	MuteTimingsExport		schema
403	Forbidden	PermissionDenied		schema

Responses

200 - MuteTimingsExport

Status: OK

Schema

403 - PermissionDenied

Status: Forbidden

Schema

PermissionDenied

Export a mute timing in provisioning file format. (RouteGetMuteTimingExport)

GET /api/v1/provisioning/mute-timings/:name/export

Produces

application/json
application/yaml
application/terraform+hcl
text/yaml
text/hcl

These outputs are for file provisioning or Terraform provisioning, and they-including the JSON output—cannot be used to update resources via the HTTP API.

Parameters

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.

All responses

Code	Status	Description	Has headers	Schema
200	OK	MuteTimingExport		schema
403	Forbidden	PermissionDenied		schema

Responses

200 - MuteTimingExport

Status: OK

Schema

403 - PermissionDenied

Status: Forbidden

Schema

PermissionDenied

Get the notification policy tree. (RouteGetPolicyTree)

GET /api/v1/provisioning/policies

All responses

Code	Status	Description	Has headers	Schema
200	OK	Route		schema

Responses

200 - Route

Status: OK

Schema

Route

Export the notification policy tree in provisioning file format. (RouteGetPolicyTreeExport)

GET /api/v1/provisioning/policies/export

Produces

application/json
application/yaml
application/terraform+hcl
text/yaml
text/hcl

These outputs are for file provisioning or Terraform provisioning, and they-including the JSON output—cannot be used to update resources via the HTTP API.

Parameters

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.

All responses

Code	Status	Description	Has headers	Schema
200	OK	AlertingFileExport		schema
404	Not Found	NotFound		schema

Responses

200 - AlertingFileExport

Status: OK

Schema

404 - NotFound

Status: Not Found

Schema

NotFound

Get a notification template group. (RouteGetTemplate)

GET /api/v1/provisioning/templates/:name

Parameters

Name	Source	Type	Go type	Required	Default	Description
`name`	path	string	string	✓		Name of the template group

All responses

Code	Status	Description	Has headers	Schema
200	OK	NotificationTemplate		schema
404	Not Found	GenericPublicError		schema

Responses

200 - NotificationTemplate

Status: OK

Schema

NotificationTemplate

404 - Not found.

Schema

Get all notification template groups. (RouteGetTemplates)

GET /api/v1/provisioning/templates

All responses

Code	Status	Description	Has headers	Schema
200	OK	NotificationTemplates		schema

Responses

200 - NotificationTemplates

Status: OK

Schema

NotificationTemplates

Create a new alert rule. (RoutePostAlertRule)

POST /api/v1/provisioning/alert-rules

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.

Parameters

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	`models.ProvisionedAlertRule`

All responses

Code	Status	Description	Has headers	Schema
201	Created	ProvisionedAlertRule		schema
400	Bad Request	ValidationError		schema

Responses

201 - ProvisionedAlertRule

Status: Created

Schema

ProvisionedAlertRule

400 - ValidationError

Status: Bad Request

Schema

Create a contact point. (RoutePostContactpoints)

POST /api/v1/provisioning/contact-points

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.

Parameters

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	`models.EmbeddedContactPoint`

All responses

Code	Status	Description	Has headers	Schema
202	Accepted	EmbeddedContactPoint		schema
400	Bad Request	ValidationError		schema

Responses

202 - EmbeddedContactPoint

Status: Accepted

Schema

EmbeddedContactPoint

400 - ValidationError

Status: Bad Request

Schema

Create a new mute timing. (RoutePostMuteTiming)

POST /api/v1/provisioning/mute-timings

Parameters

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	`models.MuteTimeInterval`

All responses

Code	Status	Description	Has headers	Schema
201	Created	MuteTimeInterval		schema
400	Bad Request	ValidationError		schema

Responses

201 - MuteTimeInterval

Status: Created

Schema

MuteTimeInterval

400 - ValidationError

Status: Bad Request

Schema

Update an existing alert rule. (RoutePutAlertRule)

PUT /api/v1/provisioning/alert-rules/:uid

Parameters

Name	Source	Type	Go type	Required	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	`models.ProvisionedAlertRule`

All responses

Code	Status	Description	Has headers	Schema
200	OK	ProvisionedAlertRule		schema
400	Bad Request	ValidationError		schema

Responses

200 - ProvisionedAlertRule

Status: OK

Schema

ProvisionedAlertRule

400 - ValidationError

Status: Bad Request

Schema

Create or update a rule group. (RoutePutAlertRuleGroup)

PUT /api/v1/provisioning/folder/:folderUid/rule-groups/:group

This action also changes the provenance setting (X-Disable-Provenance) for all alert rules in the alert group.

Parameters

Name	Source	Type	Go type	Required	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	`models.AlertRuleGroup`		This action is idempotent and rules included in this body will overwrite configured rules for the group

All responses

Code	Status	Description	Has headers	Schema
200	OK	AlertRuleGroup		schema
400	Bad Request	ValidationError		schema

Responses

200 - AlertRuleGroup

Status: OK

Schema

AlertRuleGroup

400 - ValidationError

Status: Bad Request

Schema

Update an existing contact point. (RoutePutContactpoint)

PUT /api/v1/provisioning/contact-points/:uid

Parameters

Name	Source	Type	Go type	Required	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	`models.EmbeddedContactPoint`

All responses

Code	Status	Description	Has headers	Schema
202	Accepted	Ack		schema
400	Bad Request	ValidationError		schema

Responses

202 - Ack

Status: Accepted

Schema

Ack

400 - ValidationError

Status: Bad Request

Schema

Replace an existing mute timing. (RoutePutMuteTiming)

PUT /api/v1/provisioning/mute-timings/:name

Parameters

Name	Source	Type	Go type	Required	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	`models.MuteTimeInterval`

All responses

Code	Status	Description	Schema
200	OK	MuteTimeInterval	schema
400	Bad Request	ValidationError	schema
409	Conflict	GenericPublicError	schema

Responses

200 - MuteTimeInterval

Status: OK

Schema

MuteTimeInterval

400 - ValidationError

Status: Bad Request

Schema

409 - Conflict

Status: Conflict

Schema

Sets the notification policy tree. (RoutePutPolicyTree)

Warning
Since the policy tree is a single resource, provisioning it will overwrite all policies in the notification policy tree. However, it does not affect internal policies created when alert rules directly select a contact point.

PUT /api/v1/provisioning/policies

Parameters

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	`models.Route`			The new notification routing tree to use

All responses

Code	Status	Description	Has headers	Schema
202	Accepted	Ack		schema
400	Bad Request	ValidationError		schema

Responses

202 - Ack

Status: Accepted

Schema

Ack

400 - ValidationError

Status: Bad Request

Schema

Create or update a notification template group. (RoutePutTemplate)

PUT /api/v1/provisioning/templates/:name

Parameters

Name	Source	Type	Go type	Required	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	`models.NotificationTemplateContent`

All responses

Code	Status	Description	Schema
202	Accepted	NotificationTemplate	schema
400	Bad Request	GenericPublicError	schema
409	Conflict	GenericPublicError	schema

Responses

202 - NotificationTemplate

Status: Accepted

Schema

NotificationTemplate

400 - ValidationError

Status: Bad Request

Schema

409 - Conflict

Status: Conflict

Schema

Clears the notification policy tree. (RouteResetPolicyTree)

DELETE /api/v1/provisioning/policies

All responses

Code	Status	Description	Has headers	Schema
202	Accepted	Ack		schema

Responses

202 - Ack

Status: Accepted

Schema

Ack

Models

Ack

AlertQuery

Properties

Name	Type	Go type	Description
`datasourceUid`	string	string	Grafana 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	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	`RelativeTimeRange`

AlertQueryExport

Properties

Name	Type	Go type
`datasourceUid`	string	string
`model`	interface{}	`interface{}`
`queryType`	string	string
`refId`	string	string
`relativeTimeRange`	RelativeTimeRange	`RelativeTimeRange`

AlertRuleExport

Properties

Name	Type	Go type
`annotations`	map of string	`map[string]string`
`condition`	string	string
`dashboardUid`	string	string
`data`	[]AlertQueryExport	`[]*AlertQueryExport`
`execErrState`	string	string
`for`	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

AlertRuleGroup

Properties

Name	Type	Go type
`folderUid`	string	string
`interval`	int64 (formatted integer)	int64
`rules`	[]ProvisionedAlertRule	`[]*ProvisionedAlertRule`
`title`	string	string

AlertRuleGroupExport

Properties

Name	Type	Go type
`folder`	string	string
`interval`	Duration	Duration
`name`	string	string
`orgId`	int64 (formatted integer)	int64
`rules`	[]AlertRuleExport	`[]*AlertRuleExport`

AlertingFileExport

Properties

Name	Type	Go type
`apiVersion`	int64 (formatted integer)	int64
`contactPoints`	[]ContactPointExport	`[]*ContactPointExport`
`groups`	[]AlertRuleGroupExport	`[]*AlertRuleGroupExport`
`policies`	[]NotificationPolicyExport	`[]*NotificationPolicyExport`

ContactPointExport

Properties

Name	Type	Go type
`name`	string	string
`orgId`	int64 (formatted integer)	int64
`receivers`	[]ReceiverExport	`[]*ReceiverExport`

ContactPoints

[]EmbeddedContactPoint

Duration

Name	Type	Go type	Default	Description	Example
`Duration`	string	int64

EmbeddedContactPoint

EmbeddedContactPoint is the contact point type used by Grafana-managed alerts.

Properties

Name	Type	Go type	Required	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	✓
`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`

Json

MatchRegexps

MatchType

Name	Type	Go type	Default	Description	Example
`MatchType`	int64 (formatted integer)	int64

Matcher

Properties

Name	Type	Go type
`Name`	string	string
`Type`	MatchType	MatchType
`Value`	string	string

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

MuteTimeInterval

Properties

Name	Type	Go type	Description
`name`	string	string
`time_intervals`	[]TimeInterval	`[]*TimeInterval`
`version`	string	string	Version of resource

MuteTimingExport

Properties

MuteTimingsExport

Properties

MuteTimings

[]MuteTimeInterval

NotFound

NotificationPolicyExport

Properties

Name	Type	Go type	Required	Default	Description	Example
`Policy`	RouteExport	RouteExport			inline
`orgId`	int64 (formatted integer)	int64

NotificationTemplate

Properties

Name	Type	Go type	Description
`name`	string	string
`provenance`	Provenance	Provenance
`template`	string	string
`version`	string	string	Version of resource

NotificationTemplateContent

Properties

Name	Type	Go type	Required	Default	Description	Example
`template`	string	string
`version`	string	string			Version of resource. Should be empty for new templates.

NotificationTemplates

[]NotificationTemplate

ObjectMatchers

Matchers

Inlined models

PermissionDenied

Provenance

Name	Type	Go type	Default	Description	Example
`Provenance`	string	string

ProvisionedAlertRule

Properties

Name	Type	Go type	Required	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	`[]*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	✓
`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
`ruleGroup`	string	string	✓		`eval_group_1`
`title`	string	string	✓		`Always firing`
`uid`	string	string
`updated`	date-time (formatted string)	`strfmt.DateTime`

ProvisionedAlertRules

[]ProvisionedAlertRule

RawMessage

ReceiverExport

Properties

Name	Type	Go type
`disableResolveMessage`	boolean	`bool`
`settings`	RawMessage	RawMessage
`type`	string	string
`uid`	string	string

Regexp

A Regexp is safe for concurrent use by multiple goroutines, except for configuration methods, such as Longest.