PUT
/
annotations
/
{id}

Authorizations

Authorization
string
headerrequired

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
string
required

Unique ID of the annotation

Body

application/json
datasets
string[]

array<string> of dataset names for which the annotation appears on charts

description
string

Explanation of the event the annotation marks on the charts

Maximum length: 512
endTime
string

End time of the annotation

time
string

Time the annotation marks on the charts. If you don't include this field, Axiom assigns the time of the API request to the annotation.

title
string

Summary of the annotation that appears on the charts

Maximum length: 256
type
string

Type of the event marked by the annotation. Use only alphanumeric characters or hyphens. For example, "production-deployment".

Maximum length: 256
url
string

URL relevant for the event marked by the annotation. For example, link to GitHub pull request.

Maximum length: 512

Response

200 - application/json
datasets
string[]
required

array<string> of dataset names for which the annotation appears on charts

id
string
required
time
string
required

Time the annotation marks on the charts. If you don't include this field, Axiom assigns the time of the API request to the annotation.

type
string
required

Type of the event marked by the annotation. Use only alphanumeric characters or hyphens. For example, "production-deployment".

Maximum length: 256
description
string

Explanation of the event the annotation marks on the charts

Maximum length: 512
endTime
string | null

End time of the annotation

title
string

Summary of the annotation that appears on the charts

Maximum length: 256
url
string

URL relevant for the event marked by the annotation. For example, link to GitHub pull request.

Maximum length: 512

Was this page helpful?

Create AnnotationDelete Annotation