Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kibana APM agent keys API

Configure APM agent keys to authorize requests from APM agents to the APM Server.

Kibana APM agent keys 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 keys. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 1 operation across 1 path, and defines 6 schemas. It is described by OpenAPI 3.0.3.

Requests are made against a single base URL, https://{kibana_url}.

1 operations 1 paths 6 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
Base URL
https://localhost:5601/api
Authentication
API Key, HTTP Basic
Contact
Kibana Team
Resource Areas
1

Authentication & Security 2

Kibana APM agent keys 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

APM agent keys 1

Configure APM agent keys to authorize requests from APM agents to the APM Server.

POST
/api/apm/agent_keys
Create an APM agent key
createAgentKey 2 params body → 200400401403500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are APM_UI_400_response (3 properties), APM_UI_500_response (3 properties), APM_UI_401_response (3 properties), APM_UI_403_response (3 properties). Each schema is shown below with its type and property counts.

APM_UI_403_response
object
3 properties
APM_UI_401_response
object
3 properties
APM_UI_agent_keys_object
object
2 properties 2 required
APM_UI_500_response
object
3 properties
APM_UI_agent_keys_response
object
1 property
APM_UI_400_response
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kibana-apm-agent-keys-api-openapi.yml Raw ↑

Other APIs Kibana publishes across the network.

Kibana Actions API
Kibana agent builder API
Kibana alerting API
Kibana APM agent configuration API
Kibana APM annotations API
Kibana APM server schema API
Kibana APM sourcemaps API
Kibana cases API
Kibana connectors API
Kibana Data streams API
Kibana data views API
Kibana Elastic Agent actions API