Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Vulnerability Management Assets API

9 actions 9 updates phrasing extends openapi/tenable-assets-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 9

$.info
$.paths['/assets'].get
$.paths['/assets/{asset_uuid}'].get
$.paths['/api/v2/assets/bulk-jobs/acr'].post
$.paths['/api/v2/assets/bulk-jobs/move-to-network'].post
$.paths['/api/v2/assets/bulk-jobs/delete'].post
$.paths['/import/assets'].post
$.paths['/import/asset-jobs'].get
$.paths['/import/asset-jobs/{asset_import_job_uuid}'].get

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 Vulnerability Management Assets API
  version: 1.0.0
extends: openapi/tenable-assets-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: 8
- target: $.paths['/assets'].get
  update:
    x-apievangelist-phrasing:
      intent: List assets
      effect: read
      questions:
      - What assets does Tenable know about on my network?
      - Is there a cap on how many assets the asset list returns?
      instructions:
      - text: List my assets.
      - text: Show me up to 5,000 assets from the asset list.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/assets/{asset_uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an asset's details
      effect: read
      questions:
      - What does Tenable know about one specific asset?
      - Can I look up an asset's hostnames and IPs by its UUID?
      instructions:
      - text: Show the details of asset {asset_uuid}.
        slots:
          asset_uuid: path.asset_uuid
      - text: Look up asset {asset_uuid} and summarize it.
        slots:
          asset_uuid: path.asset_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/assets/bulk-jobs/acr'].post
  update:
    x-apievangelist-phrasing:
      intent: Override Asset Criticality Ratings
      effect: write
      questions:
      - How do I change the Asset Criticality Rating Tenable assigned to some assets?
      - Do I need a Lumin license to set ACR values?
      instructions:
      - text: Overwrite the Asset Criticality Rating for my selected assets.
      - text: Set a custom ACR on a batch of assets.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/assets/bulk-jobs/move-to-network'].post
  update:
    x-apievangelist-phrasing:
      intent: Move assets to another network
      effect: write
      questions:
      - How do I move assets out of the default network into a network I created?
      - Can I move assets by IP range between networks?
      instructions:
      - text: Move assets {targets} from network {source} to network {destination}.
        slots:
          targets: requestBody.targets
          source: requestBody.source
          destination: requestBody.destination
      - text: Bulk-move the IPs {targets} from {source} into network {destination}.
        slots:
          targets: requestBody.targets
          source: requestBody.source
          destination: requestBody.destination
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/assets/bulk-jobs/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete assets matching a query
      effect: destructive
      questions:
      - How do I delete many assets at once that match a query?
      - Can I hard-delete assets so they are removed permanently?
      instructions:
      - text: Delete all assets matching {query}.
        slots:
          query: requestBody.query
      - text: Permanently delete assets matching {query} (hard_delete={hard_delete}).
        slots:
          query: requestBody.query
          hard_delete: requestBody.hard_delete
      method: generated
      generated: '2026-10-01'
- target: $.paths['/import/assets'].post
  update:
    x-apievangelist-phrasing:
      intent: Import asset records
      effect: write
      questions:
      - How do I import asset records from my own inventory in JSON?
      - What is the maximum request size for an asset import?
      instructions:
      - text: Import assets {assets} with source name {source}.
        slots:
          assets: requestBody.assets
          source: requestBody.source
      - text: Upload these asset records {assets} labelled as coming from {source}.
        slots:
          assets: requestBody.assets
          source: requestBody.source
      method: generated
      generated: '2026-10-01'
- target: $.paths['/import/asset-jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List asset import jobs
      effect: read
      questions:
      - Which asset imports have I run recently?
      - Where can I see all my asset import jobs and their statuses?
      instructions:
      - text: List my asset import jobs.
      - text: Show all recent asset import jobs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/import/asset-jobs/{asset_import_job_uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an asset import job
      effect: read
      questions:
      - Did my asset import job finish, and how many assets did it process?
      - What is the status of a specific asset import?
      instructions:
      - text: Get the status of asset import job {asset_import_job_uuid}.
        slots:
          asset_import_job_uuid: path.asset_import_job_uuid
      - text: Check whether import job {asset_import_job_uuid} has completed.
        slots:
          asset_import_job_uuid: path.asset_import_job_uuid
      method: generated
      generated: '2026-10-01'