Headers

• elastic-api-version string Required

  The version of the API to use

  Value is 2023-10-31. Default value is 2023-10-31.

Path parameters

• 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

Responses

• 200 application/json

  Successful response

  Hide response attribute Show response attribute object

  • annotations array[object]

    Annotations

    Hide annotations attributes Show annotations attributes object

    • @timestamp number
    • id string
    • text string
    • type string

      Value is version.

• 400 application/json

  Bad Request response

  Hide response attributes Show response attributes object

  • error string

    Error type

  • message string

    Error message

  • statusCode number

    Error status code

• 401 application/json

  Unauthorized response

  Hide response attributes Show response attributes object

  • error string

    Error type

  • message string

    Error message

  • statusCode number

    Error status code

• 500 application/json

  Internal Server Error response

  Hide response attributes Show response attributes object

  • error string

    Error type

  • message string

    Error message

  • statusCode number

    Error status code