Create a service annotation

Base URL: https://{kibana_url}

POST /api/apm/services/{serviceName}/annotation
POST /s/{space_id}/api/apm/services/{serviceName}/annotation

Refer to Spaces for more information.

Create a new annotation for a specific service.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Header parameters

Request body

Responses

Annotation created successfully

application/json

Bad Request response

application/json

Unauthorized response

application/json

Forbidden response

application/json

Not found response

application/json

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

No example

Authentication

Path parameters

Header parameters

Request body { }

Responses

Request body