Search for annotations

Base URL: https://{kibana_url}

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

Auth

Search for annotations related to 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

Query parameters

environment string: The environment to filter annotations by
start string: The start date for the search
end string: The end date for the search

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

{
  "annotations": [
    {
      "@timestamp": 0,
      "id": "string",
      "text": "string",
      "type": "version"
    }
  ]
}

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": "Internal Server Error",
  "message": "string",
  "statusCode": 500
}

Generated from the API spec