Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kibana Fleet uninstall tokens API

4 actions 4 updates phrasing extends openapi/elk-stack-fleet-uninstall-tokens-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 4

$.info

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

$.paths['/api/fleet/uninstall_tokens/{agentPolicyId}/rotate'].post

$.paths['/api/fleet/uninstall_tokens/{uninstallTokenId}'].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 uninstall tokens API
  version: 1.0.0
extends: openapi/elk-stack-fleet-uninstall-tokens-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: 3
- target: $.paths['/api/fleet/uninstall_tokens'].get
  update:
    x-apievangelist-phrasing:
      intent: List latest uninstall tokens per agent policy
      effect: read
      questions:
      - Which agent policies have uninstall tokens for tamper-protected Elastic Agents?
      - Can I find the uninstall token metadata for one agent policy?
      instructions:
      - text: List the latest uninstall token metadata.
      - text: Show uninstall token metadata for agent policy {policyId}.
        slots:
          policyId: query.policyId
      - text: Search uninstall tokens matching {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/uninstall_tokens/{agentPolicyId}/rotate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate an agent policy's uninstall token
      effect: write
      questions:
      - How do I rotate the uninstall token after it was shared too widely?
      - Does rotating an uninstall token require tamper protection on the policy?
      instructions:
      - text: Rotate the uninstall token for agent policy {agentPolicyId}.
        slots:
          agentPolicyId: path.agentPolicyId
      - text: Issue a fresh uninstall token for policy {agentPolicyId}.
        slots:
          agentPolicyId: path.agentPolicyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/uninstall_tokens/{uninstallTokenId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a decrypted uninstall token
      effect: read
      questions:
      - What is the actual uninstall token value I need to remove a protected agent?
      - Can I decrypt one uninstall token by its ID?
      instructions:
      - text: Get the decrypted uninstall token {uninstallTokenId}.
        slots:
          uninstallTokenId: path.uninstallTokenId
      - text: Reveal the token value for uninstall token {uninstallTokenId}.
        slots:
          uninstallTokenId: path.uninstallTokenId
      method: generated
      generated: '2026-09-26'