Search for annotations

Server: https://{kibana_url}

GET /api/apm/services/{serviceName}/annotation/search

Api key auth Basic auth

Search for annotations related to a specific service.

Path Parameters

serviceName string required: The name of the service

Query Parameters

Responses

Successful response

application/json

Bad Request response

application/json

Unauthorized response

application/json

Internal Server Error response

application/json

Examples

An example of a successful response from GET /api/apm/services/{serviceName}/annotation/search, which returns the annotations associated with a service over the given time range.

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET /api/apm/services/{serviceName}/annotation/search

curl Shell

curl -X GET "https://{kibana_url}/api/apm/services/{serviceName}/annotation/search" \
  -H "elastic-api-version: string"

Response

{
  "annotations": [
    {
      "@timestamp": 1735689600000,
      "id": "opbeans-node@2.0.0",
      "text": "opbeans-node@2.0.0",
      "type": "version"
    },
    {
      "@timestamp": 1736294400000,
      "id": "opbeans-node@2.1.0",
      "text": "opbeans-node@2.1.0",
      "type": "version"
    }
  ]
}

{
  "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": "Internal Server Error",
  "message": "An internal server error occurred. Check the Kibana server logs for details.",
  "statusCode": 500
}

Path Parameters

Query Parameters { environment , start , end , }

Responses

Query Parameters