Sign in
APM annotations

Create a service annotation

Spaces method and path for this operation:

<div><span class="operation-verb post">post</span>&nbsp;<span class="operation-path">/s/{space_id}/api/apm/services/{serviceName}/annotation</span></div>

Refer to Spaces for more information.

Create a new annotation for a specific service.

post/api/apm/services/{serviceName}/annotation

Path parameters

serviceNamestring required

The name of the service

Headers

elastic-api-version'2023-10-31' required

The version of the API to use

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

@timestampstring required

The date and time of the annotation. It must be in ISO 8601 format.

messagestring

The message displayed in the annotation. It defaults to service.version.

tagsstring[]

Tags are used by the Applications UI to distinguish APM annotations from other annotations. Tags may have additional functionality in future releases. It defaults to [apm]. While you can add additional tags, you cannot remove the apm tag.

Response

Annotation created successfully

_idstring

Identifier

_indexstring

Index

Changes

No changes recorded. 20 of the 176 revisions have no diff computed, so they could not be searched.