Search for annotations

Base URL: https://{kibana_url}

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

Auth

Search for annotations related to a specific service.

Path parameters

serviceName string required: The name of the service

Query parameters

environment string: The environment to filter annotations by
start string · format: date-time: The start date for the search; Example: 2024-01-01T00:00:00.000Z
end string · format: date-time: The end date for the search; Example: 2024-01-31T23:59:59.999Z

Header parameters

elastic-api-version enum · default: 2023-10-31 required: The version of the API to use; Values: 2023-10-31

Responses

Successful response

application/json

annotations object[]: Annotations

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

Internal Server Error 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

GET kbn:/api/apm/services/SERVICE_NAME/annotation/search

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/apm/services/${SERVICE_NAME}/annotation/search" \
  -H "elastic-api-version: 2023-10-31" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

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.

{
  "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
}