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.

Documentation

Grafana documentation

Observability as Code

JSON schema v2

annotations schema

Grafana Cloud Enterprise Open source

`annotations`

The configuration for the list of annotations that are associated with the dashboard.

  "annotations": [
    {
      "kind": "AnnotationQuery",
      "spec": {
        "builtIn": false,
        "datasource": {
          "type": "",
          "uid": ""
        },
        "enable": false,
        "hide": false,
        "iconColor": "",
        "name": ""
      }
    }
  ],

AnnotationsQueryKind consists of:

kind: “AnnotationQuery”
spec: AnnotationQuerySpec

`AnnotationQuerySpec`

Name	Type/Definition
datasource	`DataSourceRef`
query	`DataQueryKind`
enable	bool
hide	bool
iconColor	string
name	string
builtIn	bool. Default is `false`.
filter	`AnnotationPanelFilter`
options	`[string]`: A catch-all field for datasource-specific properties.