Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kibana Fleet outputs API

8 actions 8 updates phrasing extends openapi/elk-stack-fleet-outputs-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 8

$.info

$.paths['/api/fleet/logstash_api_keys'].post

$.paths['/api/fleet/outputs'].get

$.paths['/api/fleet/outputs'].post

$.paths['/api/fleet/outputs/{outputId}'].get

$.paths['/api/fleet/outputs/{outputId}'].put

$.paths['/api/fleet/outputs/{outputId}'].delete

$.paths['/api/fleet/outputs/{outputId}/health'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Kibana Fleet outputs API
  version: 1.0.0
extends: openapi/elk-stack-fleet-outputs-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: 7
- target: $.paths['/api/fleet/logstash_api_keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a Logstash API key for Fleet
      effect: write
      questions:
      - How do I get an API key so Logstash can receive data from a Fleet output?
      - Can Fleet generate the Logstash credentials for me?
      instructions:
      - text: Generate a Logstash API key for a Fleet output, sending kbn-xsrf {kbn_xsrf}.
        slots:
          kbn_xsrf: header.kbn-xsrf
      - text: Create new Logstash credentials for Fleet with kbn-xsrf header {kbn_xsrf}.
        slots:
          kbn_xsrf: header.kbn-xsrf
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/outputs'].get
  update:
    x-apievangelist-phrasing:
      intent: List Fleet outputs
      effect: read
      questions:
      - Where are my Elastic Agents configured to ship data?
      - Which Fleet outputs exist, and which one is the default?
      instructions:
      - text: List all Fleet outputs.
      - text: Show every configured Fleet output destination.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/outputs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Fleet output
      effect: write
      questions:
      - How do I add a new output, like Elasticsearch, Kafka or Logstash, for agents to send data to?
      - Can I create a second Fleet output for a different cluster?
      instructions:
      - text: Create a new Fleet output, sending kbn-xsrf {kbn_xsrf}.
        slots:
          kbn_xsrf: header.kbn-xsrf
      - text: Add a Fleet output destination for my agents with kbn-xsrf header {kbn_xsrf}.
        slots:
          kbn_xsrf: header.kbn-xsrf
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/outputs/{outputId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Fleet output
      effect: read
      questions:
      - What hosts and settings does a specific Fleet output use?
      - Can I look up one output by id?
      instructions:
      - text: Get Fleet output {outputId}.
        slots:
          outputId: path.outputId
      - text: Show the configuration of output {outputId}.
        slots:
          outputId: path.outputId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/outputs/{outputId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Fleet output
      effect: write
      questions:
      - Can I change the hosts of an existing Fleet output?
      - How do I edit an output my agents already use?
      instructions:
      - text: Update Fleet output {outputId}.
        slots:
          outputId: path.outputId
      - text: Edit the settings of output {outputId}.
        slots:
          outputId: path.outputId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/outputs/{outputId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Fleet output
      effect: destructive
      questions:
      - How do I remove a Fleet output I no longer use?
      - Is deleting an output permanent?
      instructions:
      - text: Delete Fleet output {outputId}.
        slots:
          outputId: path.outputId
      - text: Remove output {outputId}.
        slots:
          outputId: path.outputId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/outputs/{outputId}/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a Fleet output's health
      effect: read
      questions:
      - Is my Fleet output healthy and receiving data?
      - What's the latest health status reported for an output?
      instructions:
      - text: Check the health of output {outputId}.
        slots:
          outputId: path.outputId
      - text: Show the latest health state of Fleet output {outputId}.
        slots:
          outputId: path.outputId
      method: generated
      generated: '2026-09-26'