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 API
Version
1.0.0
Content negotiation
Consumes
Produces
All endpoints
Alert rules
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✓
All responses
Expand table
Code Status Description Has headers Schema 204 No Content The alert rule was deleted successfully. schema 400 Bad Request ValidationError schema
Responses
Status: No Content
Status: Bad Request
ValidationError
DELETE /api/v1/provisioning/contact-points/{UID}Consumes
Parameters
Expand table
Name Source Type Go type Separator Required Default Description UID pathstring string✓ UID should be the contact point unique identifier
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
RouteDeleteMuteTiming )
DELETE /api/v1/provisioning/mute-timings/{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 Ack schema
Responses
Status: No Content
Ack
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 Ack schema
Responses
Status: No Content
Ack
RouteGetAlertRule )
GET /api/v1/provisioning/alert-rules/{UID}Parameters
Expand table
Name Source Type Go type Separator Required Default Description UID pathstring string✓
All responses
Expand table
Code Status Description Has headers Schema 200 OK AlertRule schema 400 Bad Request ValidationError schema
Responses
Status: OK
AlertRule
Status: Bad Request
ValidationError
GET /api/v1/provisioning/contact-pointsAll responses
Responses
Status: OK
Route
Status: Bad Request
ValidationError
RouteGetMuteTiming )
GET /api/v1/provisioning/mute-timings/{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 MuteTimeInterval schema 400 Bad Request ValidationError schema
Responses
Status: OK
MuteTimeInterval
Status: Bad Request
ValidationError
RouteGetMuteTimings )
GET /api/v1/provisioning/mute-timingsAll responses
Expand table
Code Status Description Has headers Schema 200 OK MuteTimings schema 400 Bad Request ValidationError schema
Responses
Status: OK
MuteTimings
Status: Bad Request
ValidationError
RouteGetPolicyTree )
GET /api/v1/provisioning/policiesAll responses
Responses
Status: OK
Route
Status: Bad Request
ValidationError
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 MessageTemplate schema 404 Not Found NotFound schema
Responses
Status: OK
MessageTemplate
Status: Not Found
NotFound
RouteGetTemplates )
GET /api/v1/provisioning/templatesAll responses
Expand table
Code Status Description Has headers Schema 200 OK MessageTemplate schema 400 Bad Request ValidationError schema
Responses
Status: OK
MessageTemplate
Status: Bad Request
ValidationError
RoutePostAlertRule )
POST /api/v1/provisioning/alert-rulesParameters
Expand table
Name Source Type Go type Separator Required Default Description Body bodyAlertRule models.AlertRule
All responses
Expand table
Code Status Description Has headers Schema 201 Created AlertRule schema 400 Bad Request ValidationError schema
Responses
Status: Created
AlertRule
Status: Bad Request
ValidationError
RoutePostContactpoints )
POST /api/v1/provisioning/contact-pointsConsumes
Parameters
Expand table
Name Source Type Go type Separator Required Default Description 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
RoutePostMuteTiming )
POST /api/v1/provisioning/mute-timingsConsumes
Parameters
Expand table
Name Source Type Go type Separator Required Default Description 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✓ Body bodyAlertRule models.AlertRule
All responses
Expand table
Code Status Description Has headers Schema 200 OK AlertRule schema 400 Bad Request ValidationError schema
Responses
Status: OK
AlertRule
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✓ 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 should be the contact point unique identifier 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✓ Template Name 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 Body bodyRoute models.Route
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 Body bodyMessageTemplateContent models.MessageTemplateContent
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
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 object 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 Annotations map of string map[string]string{"runbook_url":"https://supercoolrunbook.com/page/13"}Condition string string✓ AData []
alertquery []*AlertQuery✓ [{"datasourceUid":"-100","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✓ Allowed values: “OK”, “Alerting”, “Error” FolderUID string string✓ project_xID int64 (formatted integer) int64Labels map of string map[string]string{"team":"sre-team-1"}NoDataState string string✓ Allowed values: “OK”, “NoData”, “Error” OrgID int64 (formatted integer) int64✓ RuleGroup string string✓ eval_group_1Title string string✓ Always firingUID string stringUpdated date-time (formatted string) strfmt.DateTimefor Duration Duration✓ provenance string Provenance
Properties
Expand table
Name Type Go type Required Default Description Example Interval int64 (formatted integer) int64
Properties
Expand table
Name Type Go type Required Default Description Example Begin int64 (formatted integer) int64End int64 (formatted integer) int64
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 string✓ Name is used as grouping key in the UI. Contact points with the same name will be grouped in the UI. webhook_1Provenance string stringType string string✓ webhookUID string stringUID is the unique identifier of the contact point. The UID can be set by the user. my_external_referencesettings object JSON✓
Expand table
Name Type Go type Default Description Example MatchType int64 (formatted integer) int64 0 = MatchEqual, 1 = MatchNotEqual, 2 = MatchRegexp, 3 = MatchNotRegexp
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 stringTemplate string stringprovenance string Provenance
Properties
Expand table
Name Type Go type Required Default Description Example Template string string
Properties
Expand table
Name Type Go type Required Default Description Example Begin int64 (formatted integer) int64End int64 (formatted integer) int64
Properties
Expand table
Name Type Go type Required Default Description Example Name string stringTimeIntervals []
timeinterval []*TimeInterval
[]
mutetimeinterval
interface{}
Matchers
Inlined models
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.
Properties
Expand table
Name Type Go type Required Default Description Example Continue boolean boolGroupByStr []string []stringMuteTimeIntervals []string []stringReceiver string stringRoutes []
route []*Routegroup_interval Duration Durationgroup_wait Duration Durationobject_matchers ObjectMatchers ObjectMatchersprovenance string Provenancerepeat_interval Duration Duration
TimeInterval describes intervals of time. ContainsTime will tell you if a golang time is contained
within the interval.
Properties
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 string
Properties
Expand table
Name Type Go type Required Default Description Example Begin int64 (formatted integer) int64End int64 (formatted integer) int64
Properties
Expand table
Name Type Go type Required Default Description Example Begin int64 (formatted integer) int64End int64 (formatted integer) int64
