Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kibana APM agent keys API

2 actions 2 updates phrasing extends openapi/elk-stack-apm-agent-keys-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Elastic Stack's API. It is a proposal applied on top of the contract, not a document Elastic Stack publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/api/apm/agent_keys'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Kibana APM agent keys API
  version: 1.0.0
extends: openapi/elk-stack-apm-agent-keys-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/api/apm/agent_keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an APM agent API key
      effect: write
      questions:
      - What's needed to create an API key my APM agents can use to send data?
      - What privileges do I need to create an APM agent key?
      instructions:
      - text: Create an APM agent key named {name} with privileges {privileges}.
        slots:
          name: requestBody.name
          privileges: requestBody.privileges
      - text: Generate APM agent key {name} granting {privileges}.
        slots:
          name: requestBody.name
          privileges: requestBody.privileges
      method: generated
      generated: '2026-09-26'