Kibana APM annotations API
Annotate visualizations in the APM app with significant events. Annotations enable you to easily see how events are impacting the performance of your applications.
Kibana APM annotations API is one of 60 APIs that Kibana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include APM annotations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 2 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3.
Requests are made against a single base URL, https://{kibana_url}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Kibana APM annotations API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (apiKeyAuth).
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
apiKeyAuth— 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 base64A…
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Annotate visualizations in the APM app with significant events. Annotations enable you to easily see how events are impacting the performance of your applications.
Schemas 8
The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are APM_UI_create_annotation_object (4 properties), APM_UI_400_response (3 properties), APM_UI_create_annotation_response (3 properties), APM_UI_403_response (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Kibana 12
Other APIs Kibana publishes across the network.