Create a service annotation

Base URL: https://{kibana_url}

POST /api/apm/services/{serviceName}/annotation
POST /s/{space_id}/api/apm/services/{serviceName}/annotation

Auth

Create a new annotation for a specific service.

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.
serviceName string required: The name of the service

Header parameters

elastic-api-version enum · default: 2023-10-31 required: The version of the API to use; Values: 2023-10-31
kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

@timestamp string required: The date and time of the annotation. It must be in ISO 8601 format.
message string: The message displayed in the annotation. It defaults to service.version.
service object required: The service that identifies the configuration to create or update.
tags string[]: 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.

Responses

Annotation created successfully

application/json

_id string: Identifier
_index string: Index
_source object: Response

Bad Request response

application/json

Unauthorized response

application/json

Forbidden response

application/json

Not found response

application/json

Base URL: https://{kibana_url}

Examples

Request curl 1 / 1 language

Run POST /api/apm/services/{serviceName}/annotation to create a deployment annotation for a service.

curl Shell

curl -X POST \
http://localhost:5601/api/apm/services/opbeans-java/annotation \
-H 'Content-Type: application/json' \
-H 'kbn-xsrf: true' \
-H 'Authorization: Basic YhUlubWZhM0FDbnlQeE6WRtaW49FQmSGZ4RUWXdX' \
-d '{
    "@timestamp": "2020-05-08T10:31:30.452Z",
    "service": {
        "version": "1.2"
    },
    "message": "Deployment 1.2"
    }'

Request

Request example

{
  "@timestamp": "2024-01-15T12:00:00.000Z",
  "message": "Deployment 1.2.0",
  "service": {
    "environment": "production",
    "version": "1.2.0"
  },
  "tags": [
    "apm",
    "deployment"
  ]
}

Response

An example of a successful response from POST /api/apm/services/opbeans-java/annotation, which creates an annotation for a service named opbeans-java.

{
  "_id": "Lc9I93EBh6DbmkeV7nFX",
  "_index": "observability-annotations",
  "_primary_term": 1,
  "_seq_no": 12,
  "_source": {
    "@timestamp": "2020-05-08T10:31:30.452Z",
    "annotation": {
      "type": "deployment"
    },
    "event": {
      "created": "2020-05-09T02:34:43.937Z"
    },
    "message": "Deployment 1.2",
    "service": {
      "name": "opbeans-java",
      "version": "1.2"
    },
    "tags": [
      "apm",
      "elastic.co",
      "customer"
    ]
  },
  "_version": 1,
  "found": true
}

{
  "error": "Bad Request",
  "message": "[request body]: expected value of type [string] but got [undefined]",
  "statusCode": 400
}

{
  "error": "Unauthorized",
  "message": "[security_exception]: missing authentication credentials for REST request",
  "statusCode": 401
}

{
  "error": "Forbidden",
  "message": "Insufficient privileges to perform this action. The APM and User Experience feature requires \u0060all\u0060 privileges.",
  "statusCode": 403
}

{
  "error": "Not Found",
  "message": "Not Found",
  "statusCode": 404
}