Kibana APM agent configuration API
Adjust APM agent configuration without need to redeploy your application.
Kibana APM agent configuration 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 agent configuration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 7 operations across 5 paths, and defines 17 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 agent configuration 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 7
Across 5 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Adjust APM agent configuration without need to redeploy your application.
Schemas 17
The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are APM_UI_agent_configuration_object (6 properties), APM_UI_search_agent_configuration_object (4 properties), APM_UI_search_agent_configuration_response (4 properties), APM_UI_404_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.