Skip to main content
PUT
/
1
/
query_annotations
/
{datasetSlug}
/
{queryAnnotationId}
Update a Query Annotation
curl --request PUT \
  --url https://api.honeycomb.io/1/query_annotations/{datasetSlug}/{queryAnnotationId} \
  --header 'Content-Type: application/json' \
  --header 'X-Honeycomb-Team: <api-key>' \
  --data '
{
  "name": "My Updated Annotation",
  "description": "A nice description of My Update Annotation",
  "query_id": "mabAMpSPDjH",
  "id": "sGUnkBHgRFN",
  "created_at": "2022-10-26T21:36:04Z",
  "updated_at": "2022-12-16T10:44:08Z"
}
'
{
  "name": "My Updated Annotation",
  "description": "A nice description of My Update Annotation",
  "query_id": "mabAMpSPDjH"
}

Authorizations

​
X-Honeycomb-Team
string
header
required

A Honeycomb Configuration Key is required to use this API. A Configuration Key can be found in the API Keys section of the environment configuration, which can be found under Environment Settings -> API Keys -> Configuration tab. Check out our documentation to find your API Keys.

More information can be found in Manage Environments.

Path Parameters

​
datasetSlug
string
required

The dataset slug or use __all__ for endpoints that support environment-wide operations.

​
queryAnnotationId
string
required

The unique identifier (ID) of the annotation.

Body

application/json

A Query Annotation consists of a name and description associated with a query to add context when collaborating.

​
name
string
required

A name for the Query.

Required string length: 1 - 320
Example:

"My Named Query"

​
query_id
string
required

The ID of the Query that the annotation describes. Note: Once created, it is NOT possible to change the query ID associated with an annotation. It is possible to have multiple annotations associated with a Query.

Example:

"mabAMpSPDjH"

​
description
string

A description of the Query.

Maximum string length: 1023
Example:

"A nice description of My Named Query"

Response

Success

A Query Annotation consists of a name and description associated with a query to add context when collaborating.

​
name
string
required

A name for the Query.

Required string length: 1 - 320
Example:

"My Named Query"

​
query_id
string
required

The ID of the Query that the annotation describes. Note: Once created, it is NOT possible to change the query ID associated with an annotation. It is possible to have multiple annotations associated with a Query.

Example:

"mabAMpSPDjH"

​
description
string

A description of the Query.

Maximum string length: 1023
Example:

"A nice description of My Named Query"

​
id
string

The unique identifier (ID) of a Query Annotation.

Example:

"sGUnkBHgRFN"

​
created_at
string<date-time>

ISO8601 formatted time when the Query Annotation was created.

Example:

"2022-10-26T21:36:04Z"

​
updated_at
string<date-time>

ISO8601 formatted time when the Query Annotation was updated.

Example:

"2022-12-04T08:14:26Z"

​
source
enum<string>

The source of the Query Annotation.

Available options:
query,
board
Example:

"query"