Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity Exposure Attack API

3 actions 3 updates phrasing extends openapi/tenable-attack-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Tenable's API. It is a proposal applied on top of the contract, not a document Tenable publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/api/profiles/{profileId}/attacks'].get

$.paths['/api/profiles/{profileId}/attacks/export'].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 Identity Exposure Attack API
  version: 1.0.0
extends: openapi/tenable-attack-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/api/profiles/{profileId}/attacks'].get
  update:
    x-apievangelist-phrasing:
      intent: List detected attacks
      effect: read
      questions:
      - Which attacks has Identity Exposure detected against a given host or domain?
      - Can I include closed attacks and filter by attack type and date?
      instructions:
      - text: List attacks in profile {profileId} for {resourceType} {resourceValue}.
        slots:
          profileId: path.profileId
          resourceType: query.resourceType
          resourceValue: query.resourceValue
      - text: Show attacks of types {attackTypeIds} on {resourceType} {resourceValue} in profile {profileId} since {dateStart}.
        slots:
          attackTypeIds: query.attackTypeIds
          resourceType: query.resourceType
          resourceValue: query.resourceValue
          profileId: path.profileId
          dateStart: query.dateStart
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/profiles/{profileId}/attacks/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export attacks as CSV
      effect: read
      questions:
      - How do I download detected attacks as a CSV file?
      - Can I export attacks for one domain to a spreadsheet?
      instructions:
      - text: Export attacks for {resourceType} {resourceValue} in profile {profileId} as CSV.
        slots:
          resourceType: query.resourceType
          resourceValue: query.resourceValue
          profileId: path.profileId
      - text: 'Download a CSV of attacks in profile {profileId} on {resourceType} {resourceValue}, closed ones included: {includeClosed}.'
        slots:
          profileId: path.profileId
          resourceType: query.resourceType
          resourceValue: query.resourceValue
          includeClosed: query.includeClosed
      method: generated
      generated: '2026-10-01'