How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Grafana Alerts API

Alerting rules and notifications

Grafana Alerts API is one of 78 APIs that Grafana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Alerts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, and 1 JSON Schema.

This API exposes 16 operations across 8 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 4 base URLs: https://{instance}.grafana.net/api, http://localhost:3000/api, http://{defaultHost}, https://{defaultHost}.

16 operations 8 paths 28 schemas 3 DELETE8 GET2 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
http://localhost:3000/api
Authentication
HTTP Bearer, HTTP Basic, API Key, API Key, HTTP Basic
Resource Areas
1

Authentication & Security 5

Grafana Alerts API declares 5 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). It accepts HTTP basic authentication (BasicAuth). An API key is passed in the header as Authorization (ApiKeyAuth). An API key is passed in the header as Authorization (api_key). It accepts HTTP basic authentication (basic).

  • BearerAuth — Service account token or API key
  • ApiKeyAuth — Format: Bearer

Paths & Operations 16

Across 8 paths, the API surfaces 16 operations — 3 DELETE, 8 GET, 2 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Alerts 16

Alerting rules and notifications

GET
/v1/provisioning/alert-rules
List all alert rules
getAlertRules → 200
POST
/v1/provisioning/alert-rules
Create an alert rule
createAlertRule body → 201
GET
/v1/provisioning/alert-rules/{uid}
Get alert rule by UID
getAlertRule 1 param → 200
PUT
/v1/provisioning/alert-rules/{uid}
Update alert rule
updateAlertRule 1 param body → 200
DELETE
/v1/provisioning/alert-rules/{uid}
Delete alert rule
deleteAlertRule 1 param → 204
GET
/v1/provisioning/contact-points
List contact points
getContactPoints → 200
POST
/v1/provisioning/contact-points
Create a contact point
createContactPoint body → 202
GET
/v1/provisioning/alert-rules/export
Grafana Route Get Alert Rules Export
routeGetAlertRulesExport 5 params → 200404
GET
/v1/provisioning/alert-rules/{UID}
Grafana Route Get Alert Rule
routeGetAlertRule 1 param → 200404
PUT
/v1/provisioning/alert-rules/{UID}
Grafana Route Put Alert Rule
routePutAlertRule 2 params body → 200400
DELETE
/v1/provisioning/alert-rules/{UID}
Grafana Route Delete Alert Rule
routeDeleteAlertRule 2 params → 204
GET
/v1/provisioning/alert-rules/{UID}/export
Grafana Route Get Alert Rule Export
routeGetAlertRuleExport 3 params → 200404
GET
/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}
Grafana Route Get Alert Rule Group
routeGetAlertRuleGroup 2 params → 200404
PUT
/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}
Grafana Route Put Alert Rule Group
routePutAlertRuleGroup 3 params body → 200400
DELETE
/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}
Grafana Route Delete Alert Rule Group
routeDeleteAlertRuleGroup 2 params → 204403404
GET
/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}/export
Grafana Route Get Alert Rule Group Export
routeGetAlertRuleGroupExport 4 params → 200404

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are ProvisionedAlertRule (20 properties), AlertRuleExportistheprovisionedfileexportofmodels.AlertRule. (16 properties), NotificationPolicyExportistheprovisionedfileexportofalerting.NotificiationPolicyV1. (14 properties), AlertRule (14 properties). Each schema is shown below with its type and property counts.

AlertRule
object
14 properties
ContactPoint
object
6 properties
RelativeTimeRangeExport
object
2 properties
AlertingFileExportisthefullprovisionedfileexport.
object
5 properties
Record
object
3 properties 2 required
AlertQueryrepresentsasinglequeryassociatedwithanalertdefinition.
object
5 properties
MuteTimeIntervalExport
object
3 properties
ValidationError
object
1 property
PublicError
object
PublicError is derived from Error and only contains information available to the end user.
4 properties
AlertRuleNotificationSettings
object
7 properties 1 required
AlertQueryExportistheprovisionedexportofmodels.AlertQuery.
object
5 properties
ProvisionedAlertRule
object
20 properties 9 required
AlertRuleExportistheprovisionedfileexportofmodels.AlertRule.
object
16 properties
TimeIntervalrepresentsanamedsetoftimeintervalsforwhicharouteshouldbemuted.
object
2 properties
AlertRuleGroup
object
4 properties
RelativeTimeRange
object
RelativeTimeRange is the per query start and end time for requests.
2 properties
Matchermodelsthematchingofalabel.
object
3 properties
NoDataState
string
AlertRuleGroupExportistheprovisionedfileexportofAlertRuleGroupV1.
object
5 properties
format
string
Recordistheprovisionedexportofmodels.Record.
object
3 properties
ForbiddenError
object
1 property
NotificationPolicyExportistheprovisionedfileexportofalerting.NotificiationPolicyV1.
object
14 properties
ExecErrState
string
ReceiverExportistheprovisionedfileexportofalerting.ReceiverV1.
object
4 properties
AlertRuleNotificationSettingsExportistheprovisionedexportofmodels.NotificationSettings.
object
7 properties
RouteExport
object
RouteExport is the provisioned file export of definitions.Route. This is needed to hide fields that aren't useable in provisioning file format. An alternative…
13 properties
ContactPointExportistheprovisionedfileexportofalerting.ContactPointV1.
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

grafana-alerts-api-openapi.yml Raw ↑

Other APIs Grafana publishes across the network.

Grafana Access API
Grafana Account API
Grafana Accounts API
Grafana Add API
Grafana Address API
Grafana Administrative API
Grafana All API
Grafana Annotations API
Grafana Built API
Grafana Cache API
Grafana Call API
Grafana Calls API
Where this information came from

This is an independent, third-party profile of Grafana Alerts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.