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: Timestamp
message string: Message
service object required: Service
tags string[]: Tags

Responses

Annotation created successfully

application/json

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

Bad Request response

application/json

error string: Error type
message string: Error message
statusCode number: Error status code

Unauthorized response

application/json

error string: Error type
message string: Error message
statusCode number: Error status code

Forbidden response

application/json

error string: Error type
message string: Error message
statusCode number: Error status code

Not found response

application/json

error string: Error type
message string: Error message
statusCode number: Error status code

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/apm/services/SERVICE_NAME/annotation
{
  "@timestamp": "string",
  "service": {
    "version": "string"
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/apm/services/${SERVICE_NAME}/annotation" \
  -H "elastic-api-version: 2023-10-31" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "@timestamp": "string",
    "service": {
      "version": "string"
    }
  }'

Generated from the API spec

Response

{
  "_id": "string",
  "_index": "string",
  "_source": {
    "@timestamp": "string",
    "annotation": {
      "title": "string",
      "type": "string"
    },
    "event": {
      "created": "string"
    },
    "message": "string",
    "service": {
      "environment": "string",
      "name": "string",
      "version": "string"
    },
    "tags": [
      "string"
    ]
  }
}

Generated from the API spec

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

Generated from the API spec

{
  "error": "Unauthorized",
  "message": "string",
  "statusCode": 401
}

Generated from the API spec

{
  "error": "Forbidden",
  "message": "string",
  "statusCode": 403
}

Generated from the API spec

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

Generated from the API spec