# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Tenable Scans API version: 1.0.0 extends: openapi/tenable-scans-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: 17 - target: $.paths['/pci-asv/scans/list'].get update: x-apievangelist-phrasing: intent: List PCI ASV scans effect: read questions: - Where can I see all of my PCI ASV compliance scans? - Does listing PCI ASV scans require special access from Tenable support? - Can I page through PCI scans with a limit and offset? instructions: - text: List my PCI ASV scans. - text: List {limit} PCI ASV scans sorted by {sort}. slots: limit: query.limit sort: query.sort method: generated generated: '2026-10-01' - target: $.paths['/scans'].get update: x-apievangelist-phrasing: intent: List vulnerability management scans effect: read questions: - Which vulnerability management scans can I view in my account? - Can I list only the scans in a particular folder? - How do I find scans that were modified after a certain date? instructions: - text: List all scans in folder {folder_id}. slots: folder_id: query.folder_id - text: Show scans modified since {last_modification_date}. slots: last_modification_date: query.last_modification_date - text: List the network scans I have permission to view. method: generated generated: '2026-10-01' - target: $.paths['/scans'].post update: x-apievangelist-phrasing: intent: Create a vulnerability scan configuration effect: write questions: - How do I create a new network vulnerability scan from a template? - Is there a limit on how many active scans my account can have? - Can I attach credentials and audit files when setting up a new scan? instructions: - text: Create a new scan from template {uuid} with settings {settings}. slots: uuid: requestBody.uuid settings: requestBody.settings - text: Set up a credentialed scan using template {uuid}, settings {settings} and credentials {credentials}. slots: uuid: requestBody.uuid settings: requestBody.settings credentials: requestBody.credentials method: generated generated: '2026-10-01' - target: $.paths['/scans/{scan_id}'].get update: x-apievangelist-phrasing: intent: Get results of a vulnerability scan effect: read questions: - How can I see the results from the latest run of a scan? - Can I pull results from an older run of a scan instead of the latest one? - What hosts and vulnerabilities did my last network scan find? instructions: - text: Get the latest results for scan {scan_id}. slots: scan_id: path.scan_id - text: Show results of scan {scan_id} from historical run {history_id}. slots: scan_id: path.scan_id history_id: query.history_id method: generated generated: '2026-10-01' - target: $.paths['/scans/{scan_id}'].put update: x-apievangelist-phrasing: intent: Update a vulnerability scan's configuration effect: write questions: - Can I change the targets or schedule of an existing network scan? - How do I disable a scan without deleting it? - Is it possible to rename a scan or move it to another folder? instructions: - text: Update scan {scan_id} with new settings {settings} using template {uuid}. slots: scan_id: path.scan_id settings: requestBody.settings uuid: requestBody.uuid - text: Change the plugins enabled on scan {scan_id} to {plugins}, keeping template {uuid} and settings {settings}. slots: scan_id: path.scan_id plugins: requestBody.plugins uuid: requestBody.uuid settings: requestBody.settings method: generated generated: '2026-10-01' - target: $.paths['/scans/{scan_id}'].delete update: x-apievangelist-phrasing: intent: Delete a vulnerability scan effect: destructive questions: - How do I delete a network scan I no longer need? - Why can't I delete a scan that is running or paused? instructions: - text: Delete scan {scan_id}. slots: scan_id: path.scan_id - text: Remove the network scan {scan_id} from my account. slots: scan_id: path.scan_id method: generated generated: '2026-10-01' - target: $.paths['/was/v2/configs/{config_id}/scans'].post update: x-apievangelist-phrasing: intent: Launch a web app scan from a configuration effect: write questions: - How do I start a web application scan from a saved scan configuration? - Can I kick off a WAS scan on demand instead of waiting for the schedule? instructions: - text: Launch a web app scan using configuration {config_id}. slots: config_id: path.config_id - text: Run WAS scan config {config_id} now. slots: config_id: path.config_id method: generated generated: '2026-10-01' - target: $.paths['/api/v3/was/import'].post update: x-apievangelist-phrasing: intent: Import a previously exported web app scan effect: write questions: - Can I import a web app scan that I exported earlier as JSON? - Which export formats can't be imported back into Web App Scanning? instructions: - text: Import the exported web app scan file {Filedata}. slots: Filedata: requestBody.Filedata - text: Upload my JSON web app scan export so it shows up in Web App Scanning. method: generated generated: '2026-10-01' - target: $.paths['/was/v2/configs/{config_id}/scans/search'].post update: x-apievangelist-phrasing: intent: Search web app scans for a configuration effect: read questions: - Which web app scans have run under a given scan configuration? - Can I sort and page the scan runs for one WAS configuration? instructions: - text: Search the scans run from web app configuration {config_id}. slots: config_id: path.config_id - text: List the last {limit} scans of WAS config {config_id} sorted by {sort}. slots: limit: query.limit config_id: path.config_id sort: query.sort method: generated generated: '2026-10-01' - target: $.paths['/was/v2/scans/{scan_id}'].get update: x-apievangelist-phrasing: intent: Get details of a web app scan effect: read questions: - What is the status and metadata of a specific web application scan? - Where do I look up details for one WAS scan run? instructions: - text: Get details for web app scan {scan_id}. slots: scan_id: path.scan_id - text: Show me WAS scan {scan_id}. slots: scan_id: path.scan_id method: generated generated: '2026-10-01' - target: $.paths['/was/v2/scans/{scan_id}'].delete update: x-apievangelist-phrasing: intent: Delete a web app scan and its findings effect: destructive questions: - How do I remove a web app scan along with the vulnerabilities it found? - Is deleting a WAS scan immediate or does it run as a background job? instructions: - text: Delete web app scan {scan_id} and its vulnerabilities. slots: scan_id: path.scan_id - text: Remove WAS scan {scan_id}. slots: scan_id: path.scan_id method: generated generated: '2026-10-01' - target: $.paths['/was/v2/scans/{scan_id}'].patch update: x-apievangelist-phrasing: intent: Pause, resume or stop a web app scan effect: write questions: - Can I pause a running web application scan and resume it later? - How do I stop a WAS scan that is currently running? - Which actions are allowed depending on a web app scan's current status? instructions: - text: Set the requested action on web app scan {scan_id} to {requested_action}. slots: scan_id: path.scan_id requested_action: requestBody.requested_action - text: Pause WAS scan {scan_id} by requesting {requested_action}. slots: scan_id: path.scan_id requested_action: requestBody.requested_action method: generated generated: '2026-10-01' - target: $.paths['/was/v2/scans/{scan_id}/notes'].get update: x-apievangelist-phrasing: intent: List notes on a web app scan effect: read questions: - Are there any notes or warnings recorded for my web app scan? - Can I page through the notes attached to a WAS scan? instructions: - text: Get the notes for web app scan {scan_id}. slots: scan_id: path.scan_id - text: Show the first {limit} notes on WAS scan {scan_id}. slots: limit: query.limit scan_id: path.scan_id method: generated generated: '2026-10-01' - target: $.paths['/was/v2/scans/{scan_id}/vulnerabilities/search'].post update: x-apievangelist-phrasing: intent: Search vulnerabilities found by a web app scan effect: read questions: - What vulnerabilities did a particular web application scan find? - Can I page and sort the findings from one WAS scan? instructions: - text: Search vulnerabilities detected by web app scan {scan_id}. slots: scan_id: path.scan_id - text: List {limit} findings from WAS scan {scan_id} sorted by {sort}. slots: limit: query.limit scan_id: path.scan_id sort: query.sort method: generated generated: '2026-10-01' - target: $.paths['/was/v2/scans/{scan_id}/report'].get update: x-apievangelist-phrasing: intent: Download a generated web app scan report effect: read questions: - How do I download a web app scan report once it has been generated? - Why do I get a 404 when downloading a WAS scan report? instructions: - text: Download the generated report for web app scan {scan_id}. slots: scan_id: path.scan_id - text: Fetch the finished WAS report file for scan {scan_id}. slots: scan_id: path.scan_id method: generated generated: '2026-10-01' - target: $.paths['/was/v2/scans/{scan_id}/report'].put update: x-apievangelist-phrasing: intent: Generate a web app scan report effect: write questions: - Can I generate a report of a web app scan's results in a specific format? - What do I call first to produce a WAS scan report before downloading it? instructions: - text: Generate a results report for web app scan {scan_id}. slots: scan_id: path.scan_id - text: Start building the results report for WAS scan {scan_id}. slots: scan_id: path.scan_id method: generated generated: '2026-10-01' - target: $.paths['/api/v3/export/{scan_id}'].get update: x-apievangelist-phrasing: intent: Download debug ZIP for a web app scan effect: read questions: - How can I get browser console logs and HTTP traffic to troubleshoot a web app scan? - Does the WAS debug bundle include Selenium information? instructions: - text: Download the debug ZIP for web app scan {scan_id}. slots: scan_id: path.scan_id - text: Get troubleshooting logs for WAS scan {scan_id}. slots: scan_id: path.scan_id method: generated generated: '2026-10-01'