Annotations API

This is the API documentation for the new Grafana Annotations feature released in Grafana 4.6. Annotations are saved in the Grafana database (sqlite, mysql or postgres). Annotations can be organization annotations that can be shown on any dashboard by configuring an annotation data source - they are filtered by tags. Or they can be tied to a panel on a dashboard and are then only shown on that panel.

If you are running Grafana Enterprise, for some endpoints you’ll need to have specific permissions. Refer to Role-based access control permissions for more information.

Find Annotations

GET /api/annotations?from=1506676478816&to=1507281278816&tags=tag1&tags=tag2&limit=100

Required permissions

See note in the introduction for an explanation.

ActionScope
annotations:readannotations:type:

Example Request:

  1. GET /api/annotations?from=1506676478816&to=1507281278816&tags=tag1&tags=tag2&limit=100 HTTP/1.1
  2. Accept: application/json
  3. Content-Type: application/json
  4. Authorization: Basic YWRtaW46YWRtaW4=

Query Parameters:

  • from: epoch datetime in milliseconds. Optional.
  • to: epoch datetime in milliseconds. Optional.
  • limit: number. Optional - default is 100. Max limit for results returned.
  • alertId: number. Optional. Find annotations for a specified alert.
  • dashboardId: number. Optional. Find annotations that are scoped to a specific dashboard
  • dashboardUID: string. Optional. Find annotations that are scoped to a specific dashboard, when dashboardUID presents, dashboardId would be ignored.
  • panelId: number. Optional. Find annotations that are scoped to a specific panel
  • userId: number. Optional. Find annotations created by a specific user
  • type: string. Optional. alert|annotation Return alerts or user created annotations
  • tags: string. Optional. Use this to filter organization annotations. Organization annotations are annotations from an annotation data source that are not connected specifically to a dashboard or panel. To do an “AND” filtering with multiple tags, specify the tags parameter multiple times e.g. tags=tag1&tags=tag2.

Example Response:

  1. HTTP/1.1 200
  2. Content-Type: application/json
  3. [
  4.     {
  5.         "id": 1124,
  6.         "alertId": 0,
  7.         "dashboardId": 468,
  8.         "dashboardUID": "uGlb_lG7z",
  9.         "panelId": 2,
  10.         "userId": 1,
  11.         "userName": "",
  12.         "newState": "",
  13.         "prevState": "",
  14.         "time": 1507266395000,
  15.         "timeEnd": 1507266395000,
  16.         "text": "test",
  17.         "metric": "",
  18.         "tags": [
  19.             "tag1",
  20.             "tag2"
  21.         ],
  22.         "data": {}
  23.     },
  24.     {
  25.         "id": 1123,
  26.         "alertId": 0,
  27.         "dashboardId": 468,
  28.         "dashboardUID": "jcIIG-07z",
  29.         "panelId": 2,
  30.         "userId": 1,
  31.         "userName": "",
  32.         "newState": "",
  33.         "prevState": "",
  34.         "time": 1507265111000,
  35.         "text": "test",
  36.         "metric": "",
  37.         "tags": [
  38.             "tag1",
  39.             "tag2"
  40.         ],
  41.         "data": {}
  42.     }
  43. ]

Starting in Grafana v6.4 regions annotations are now returned in one entity that now includes the timeEnd property.

Create Annotation

Creates an annotation in the Grafana database. The dashboardId and panelId fields are optional. If they are not specified then an organization annotation is created and can be queried in any dashboard that adds the Grafana annotations data source. When creating a region annotation include the timeEnd property.

The format for time and timeEnd should be epoch numbers in millisecond resolution.

POST /api/annotations

Required permissions

See note in the introduction for an explanation.

ActionScope
annotations:createannotations:type:

Example Request:

  1. POST /api/annotations HTTP/1.1
  2. Accept: application/json
  3. Content-Type: application/json
  5. {
  6.   "dashboardUID":"jcIIG-07z",
  7.   "panelId":1,
  8.   "time":1507037197339,
  9.   "timeEnd":1507180805056,
  10.   "tags":["tag1","tag2"],
  11.   "text":"Annotation Description"
  12. }

Example Response:

  1. HTTP/1.1 200
  2. Content-Type: application/json
  4. {
  5.     "message":"Annotation added",
  6.     "id": 1,
  7. }

The response for this HTTP request is slightly different in versions prior to v6.4. In prior versions you would also get an endId if you where creating a region. But in 6.4 regions are represented using a single event with time and timeEnd properties.

Create Annotation in Graphite format

Creates an annotation by using Graphite-compatible event format. The when and data fields are optional. If when is not specified then the current time will be used as annotation’s timestamp. The tags field can also be in prior to Graphite 0.10.0 format (string with multiple tags being separated by a space).

POST /api/annotations/graphite

Required permissions

See note in the introduction for an explanation.

ActionScope
annotations:createannotations:type:organization

Example Request:

  1. POST /api/annotations/graphite HTTP/1.1
  2. Accept: application/json
  3. Content-Type: application/json
  5. {
  6.   "what": "Event - deploy",
  7.   "tags": ["deploy", "production"],
  8.   "when": 1467844481,
  9.   "data": "deploy of master branch happened at Wed Jul 6 22:34:41 UTC 2016"
  10. }

Example Response:

  1. HTTP/1.1 200
  2. Content-Type: application/json
  4. {
  5.     "message":"Graphite annotation added",
  6.     "id": 1
  7. }

Update Annotation

PUT /api/annotations/:id

Updates all properties of an annotation that matches the specified id. To only update certain property, consider using the Patch Annotation operation.

Required permissions

See note in the introduction for an explanation.

ActionScope
annotations:writeannotations:type:

Example Request:

  1. PUT /api/annotations/1141 HTTP/1.1
  2. Accept: application/json
  3. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
  4. Content-Type: application/json
  6. {
  7.   "time":1507037197339,
  8.   "timeEnd":1507180805056,
  9.   "text":"Annotation Description",
  10.   "tags":["tag3","tag4","tag5"]
  11. }

Example Response:

  1. HTTP/1.1 200
  2. Content-Type: application/json
  4. {
  5.     "message":"Annotation updated"
  6. }

Patch Annotation

This is available in Grafana 6.0.0-beta2 and above.

PATCH /api/annotations/:id

Updates one or more properties of an annotation that matches the specified id.

This operation currently supports updating of the text, tags, time and timeEnd properties.

Required permissions

See note in the introduction for an explanation.

ActionScope
annotations:writeannotations:type:

Example Request:

  1. PATCH /api/annotations/1145 HTTP/1.1
  2. Accept: application/json
  3. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
  4. Content-Type: application/json
  6. {
  7.   "text":"New Annotation Description",
  8.   "tags":["tag6","tag7","tag8"]
  9. }

Example Response:

  1. HTTP/1.1 200
  2. Content-Type: application/json
  4. {
  5.     "message":"Annotation patched"
  6. }

Delete Annotation By Id

DELETE /api/annotations/:id

Deletes the annotation that matches the specified id.

Required permissions

See note in the introduction for an explanation.

ActionScope
annotations:deleteannotations:type:

Example Request:

  1. DELETE /api/annotations/1 HTTP/1.1
  2. Accept: application/json
  3. Content-Type: application/json
  4. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Example Response:

  1. HTTP/1.1 200
  2. Content-Type: application/json
  4. {
  5.     "message":"Annotation deleted"
  6. }

Find Annotations Tags

GET /api/annotations/tags

Find all the event tags created in the annotations.

Required permissions

See note in the introduction for an explanation.

ActionScope
annotations:readN/A

Example Request:

  1. GET /api/annotations/tags?tag=out HTTP/1.1
  2. Accept: application/json
  3. Content-Type: application/json
  4. Authorization: Basic YWRtaW46YWRtaW4=

Query Parameters:

  • tag: Optional. A string that you can use to filter tags.
  • limit: Optional. A number, where the default is 100. Max limit for results returned.

Example Response:

  1. HTTP/1.1 200
  2. Content-Type: application/json
  4. {
  5.     "result": {
  6.         "tags": [
  7.             {
  8.                 "tag": "outage",
  9.                 "count": 1
  10.             }
  11.         ]
  12.     }
  13. }