How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Stack (ELK Stack) APM agent configuration API

Adjust APM agent configuration without need to redeploy your application.

Elastic Stack (ELK Stack) APM agent configuration API is one of 132 APIs that Elastic Stack (ELK Stack) 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 an API reference.

This API exposes 7 operations across 5 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0.

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

7 operations 5 paths 17 schemas 1 DELETE4 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://{elasticsearch_endpoint}
Authentication
API Key, HTTP Basic
Contact
Kibana Team
Resource Areas
1

Authentication & Security 2

Elastic Stack (ELK Stack) 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.

APM agent configuration 7

Adjust APM agent configuration without need to redeploy your application.

DELETE
/api/apm/settings/agent-configuration
Delete agent configuration
deleteAgentConfiguration 2 params body → 200400401403404
GET
/api/apm/settings/agent-configuration
Get a list of agent configurations
getAgentConfigurations 1 param → 200400401404
PUT
/api/apm/settings/agent-configuration
Create or update agent configuration
createUpdateAgentConfiguration 3 params body → 200400401403404
GET
/api/apm/settings/agent-configuration/agent_name
Get agent name for service
getAgentNameForService 2 params → 200400401404
GET
/api/apm/settings/agent-configuration/environments
Get environments for service
getEnvironmentsForService 2 params → 200400401404
POST
/api/apm/settings/agent-configuration/searchdeprecated
Lookup single agent configuration
searchSingleConfiguration 2 params body → 200400401404
GET
/api/apm/settings/agent-configuration/view
Get single agent configuration
getSingleAgentConfiguration 3 params → 200400401404

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_response (4 properties), APM_UI_search_agent_configuration_object (4 properties), APM_UI_agent_configuration_intake_object (3 properties). Each schema is shown below with its type and property counts.

APM_UI_401_response
object
3 properties
APM_UI_single_agent_configuration_response
APM_UI_delete_service_object
object
Service
1 property 1 required
APM_UI_agent_configurations_response
object
1 property
APM_UI_service_environment_object
object
2 properties
APM_UI_403_response
object
3 properties
APM_UI_search_agent_configuration_response
object
4 properties
APM_UI_search_agent_configuration_object
object
4 properties 1 required
APM_UI_404_response
object
3 properties
APM_UI_delete_agent_configurations_response
object
1 property
APM_UI_service_agent_name_response
object
1 property
APM_UI_service_environments_response
object
1 property
APM_UI_400_response
object
3 properties
APM_UI_agent_configuration_object
object
Agent configuration
6 properties 4 required
APM_UI_service_object
object
Service
2 properties
APM_UI_agent_configuration_intake_object
object
3 properties 2 required
APM_UI_settings_object
object
Agent configuration settings

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elk-stack-apm-agent-configuration-api-openapi.yml Raw ↑

Other APIs Elastic Stack (ELK Stack) publishes across the network.

Elastic Cloud API
Elastic Stack (ELK Stack) Accounts API
Elastic Stack (ELK Stack) Actions API
Elastic Stack (ELK Stack) agent builder API
Elastic Stack (ELK Stack) Alerting API
Elastic Stack (ELK Stack) Alerting V2 API
Elastic Stack (ELK Stack) Analytics API
Elastic Stack (ELK Stack) APM agent keys API
Elastic Stack (ELK Stack) APM annotations API
Elastic Stack (ELK Stack) APM server schema API
Elastic Stack (ELK Stack) APM sourcemaps API
Elastic Stack (ELK Stack) Authentication API
Where this information came from

This is an independent, third-party profile of Elastic Stack (ELK Stack) APM agent configuration API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.