Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kibana Fleet Server hosts API

6 actions 6 updates phrasing extends openapi/elk-stack-fleet-server-hosts-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 6

$.info

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

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

$.paths['/api/fleet/fleet_server_hosts/{itemId}'].get

$.paths['/api/fleet/fleet_server_hosts/{itemId}'].put

$.paths['/api/fleet/fleet_server_hosts/{itemId}'].delete

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 Server hosts API
  version: 1.0.0
extends: openapi/elk-stack-fleet-server-hosts-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: 5
- target: $.paths['/api/fleet/fleet_server_hosts'].get
  update:
    x-apievangelist-phrasing:
      intent: List Fleet Server hosts
      effect: read
      questions:
      - Which Fleet Server hosts are configured in Fleet?
      - Where can I see all the Fleet Server URLs my agents may connect to?
      instructions:
      - text: List all Fleet Server hosts.
      - text: Show every configured Fleet Server host and its URLs.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/fleet_server_hosts'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a Fleet Server host
      effect: write
      questions:
      - How do I register a new Fleet Server host that Elastic Agents can enroll through?
      - Can I make a new Fleet Server host the default one?
      instructions:
      - text: Create Fleet Server host {name} with URLs {host_urls}.
        slots:
          name: requestBody.name
          host_urls: requestBody.host_urls
      - text: Add Fleet Server host {name} at {host_urls} routed through proxy {proxy_id}.
        slots:
          name: requestBody.name
          host_urls: requestBody.host_urls
          proxy_id: requestBody.proxy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/fleet_server_hosts/{itemId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Fleet Server host
      effect: read
      questions:
      - What URLs and SSL settings does a specific Fleet Server host have?
      - Can I check whether one Fleet Server host is the default?
      instructions:
      - text: Show Fleet Server host {itemId}.
        slots:
          itemId: path.itemId
      - text: Get the configuration of Fleet Server host {itemId}.
        slots:
          itemId: path.itemId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/fleet_server_hosts/{itemId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Fleet Server host
      effect: write
      questions:
      - How do I change the URLs of an existing Fleet Server host?
      - Can I switch which proxy an existing Fleet Server host uses?
      instructions:
      - text: Update Fleet Server host {itemId} to use URLs {host_urls}.
        slots:
          itemId: path.itemId
          host_urls: requestBody.host_urls
      - text: Rename Fleet Server host {itemId} to {name}.
        slots:
          itemId: path.itemId
          name: requestBody.name
      - text: Make existing Fleet Server host {itemId} the default by setting is_default to {is_default}.
        slots:
          itemId: path.itemId
          is_default: requestBody.is_default
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/fleet_server_hosts/{itemId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Fleet Server host
      effect: destructive
      questions:
      - How do I remove a Fleet Server host from Fleet?
      - What happens to agents if I delete a Fleet Server host entry?
      instructions:
      - text: Delete Fleet Server host {itemId}.
        slots:
          itemId: path.itemId
      - text: Remove the Fleet Server host entry {itemId} from Fleet.
        slots:
          itemId: path.itemId
      method: generated
      generated: '2026-09-26'