Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kibana Fleet proxies API

6 actions 6 updates phrasing extends openapi/elk-stack-fleet-proxies-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/proxies'].get
$.paths['/api/fleet/proxies'].post
$.paths['/api/fleet/proxies/{itemId}'].get
$.paths['/api/fleet/proxies/{itemId}'].put
$.paths['/api/fleet/proxies/{itemId}'].delete

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 Fleet proxies API
  version: 1.0.0
extends: openapi/elk-stack-fleet-proxies-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/proxies'].get
  update:
    x-apievangelist-phrasing:
      intent: List Fleet proxies
      effect: read
      questions:
      - Which proxies are configured for Fleet and Elastic Agents?
      - Can I see all the Fleet proxy URLs in one list?
      instructions:
      - text: List all Fleet proxies.
      - text: Show every proxy configured in Fleet settings.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/proxies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Fleet proxy
      effect: write
      questions:
      - How do I route Elastic Agent traffic through a proxy in Fleet?
      - Can I attach a client certificate and custom headers to a new Fleet proxy?
      instructions:
      - text: Create a Fleet proxy named {name} at {url}.
        slots:
          name: requestBody.name
          url: requestBody.url
      - text: Add Fleet proxy {name} for {url} with proxy headers {proxy_headers}.
        slots:
          name: requestBody.name
          url: requestBody.url
          proxy_headers: requestBody.proxy_headers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/proxies/{itemId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Fleet proxy
      effect: read
      questions:
      - What URL and certificates does a specific Fleet proxy use?
      - Can I look up one Fleet proxy by its ID?
      instructions:
      - text: Show Fleet proxy {itemId}.
        slots:
          itemId: path.itemId
      - text: Get the configuration of proxy {itemId} in Fleet.
        slots:
          itemId: path.itemId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/proxies/{itemId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Fleet proxy
      effect: write
      questions:
      - How do I change the URL of an existing Fleet proxy?
      - Can I rotate the certificate on a Fleet proxy I already set up?
      instructions:
      - text: Change Fleet proxy {itemId} to use URL {url}.
        slots:
          itemId: path.itemId
          url: requestBody.url
      - text: Update the certificate on proxy {itemId} to {certificate}.
        slots:
          itemId: path.itemId
          certificate: requestBody.certificate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/proxies/{itemId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Fleet proxy
      effect: destructive
      questions:
      - How do I remove a proxy from Fleet settings?
      - Can I delete a Fleet proxy by ID?
      instructions:
      - text: Delete Fleet proxy {itemId}.
        slots:
          itemId: path.itemId
      - text: Remove the proxy {itemId} from Fleet.
        slots:
          itemId: path.itemId
      method: generated
      generated: '2026-09-26'