INinfluxdata
sources
annotations

POST /sources/{id}/annotations/

Changed on

Create an annotation

Request

  • Base URL
    /chronograf/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /chronograf/v1/sources/{id}/annotations/
  • Auth
    none declared

Path parameters

idstring required

ID of the source

Request body

startTimestring

RFC3339 datetime for the start of the annotation

endTimestring

RFC3339 datetime for the end of the annotation

textstring

A user-facing description of the annotation

colorstring

Annotation color

tagsobject

A set of user-defined tags associated with the annotation

Example request

{
  "text": "new annotation text"
}

Response

The created annotation

idstring

ID of the annotation

startTimestring

RFC3339 datetime for the start of the annotation

endTimestring

RFC3339 datetime for the end of the annotation

textstring

A user-facing description of the annotation

colorstring

Annotation color

tagsobject

A set of user-defined tags associated with the annotation

Example response

{
  "id": "59434c1c-fa16-40e9-8b92-af71544cc3eb",
  "startTime": "2018-07-09T17:48:04.23Z",
  "endTime": "2018-07-09T17:48:08.652Z",
  "text": "no name",
  "color": "red",
  "tags": {
    "repo": "influxdata/chronograf"
  },
  "links": {
    "self": "/chronograf/v1/sources/1/annotations/59434c1c-fa16-40e9-8b92-af71544cc3eb"
  }
}

Changes