# 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 enrollment API keys API
  version: 1.0.0
extends: openapi/elk-stack-fleet-enrollment-api-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: 5
- target: $.paths['/api/fleet/enrollment_api_keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List Fleet enrollment API keys
      effect: read
      questions:
      - Which enrollment tokens exist for enrolling Elastic Agents?
      - Can I filter enrollment API keys with a KQL query?
      instructions:
      - text: List Fleet enrollment API keys.
      - text: Find enrollment keys matching {kuery}, {perPage} per page.
        slots:
          kuery: query.kuery
          perPage: query.perPage
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/enrollment_api_keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Fleet enrollment API key
      effect: write
      questions:
      - How do I create an enrollment token so new agents join a specific policy?
      - Can I set an expiration on a Fleet enrollment key?
      instructions:
      - text: Create an enrollment API key for agent policy {policy_id}.
        slots:
          policy_id: requestBody.policy_id
      - text: Create enrollment key {name} for policy {policy_id} expiring {expiration}.
        slots:
          name: requestBody.name
          policy_id: requestBody.policy_id
          expiration: requestBody.expiration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/enrollment_api_keys/_bulk_delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk revoke or delete enrollment API keys
      effect: destructive
      questions:
      - How do I revoke many Fleet enrollment tokens at once?
      - Can I delete enrollment keys matching a query instead of listing ids?
      instructions:
      - text: Revoke enrollment keys {tokenIds}.
        slots:
          tokenIds: requestBody.tokenIds
      - text: Bulk delete enrollment keys matching {kuery} with forceDelete {forceDelete}.
        slots:
          kuery: requestBody.kuery
          forceDelete: requestBody.forceDelete
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/enrollment_api_keys/{keyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Fleet enrollment API key
      effect: read
      questions:
      - What policy is a particular enrollment token tied to?
      - Can I view one enrollment key and whether it's still active?
      instructions:
      - text: Get enrollment API key {keyId}.
        slots:
          keyId: path.keyId
      - text: Show details of enrollment token {keyId}.
        slots:
          keyId: path.keyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/fleet/enrollment_api_keys/{keyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke or delete one enrollment API key
      effect: destructive
      questions:
      - How do I revoke a single leaked enrollment token?
      - Can I fully delete an enrollment key instead of just revoking it?
      instructions:
      - text: Revoke enrollment API key {keyId}.
        slots:
          keyId: path.keyId
      - text: Delete enrollment key {keyId} outright with forceDelete {forceDelete}.
        slots:
          keyId: path.keyId
          forceDelete: query.forceDelete
      method: generated
      generated: '2026-09-26'