Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Vulnerability Management Scan Control API

6 actions 6 updates phrasing extends openapi/tenable-scan-control-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 6

$.info
$.paths['/scans/{scan_id}/launch'].post
$.paths['/scans/{scan_id}/pause'].post
$.paths['/scans/{scan_id}/resume'].post
$.paths['/scans/{scan_id}/stop'].post
$.paths['/scans/{schedule_uuid}/force-stop'].post

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 Scan Control API
  version: 1.0.0
extends: openapi/tenable-scan-control-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: 5
- target: $.paths['/scans/{scan_id}/launch'].post
  update:
    x-apievangelist-phrasing:
      intent: Launch a scan
      effect: write
      questions:
      - How do I start a vulnerability scan right now?
      - Can I launch a scan against different targets than it's configured for?
      - Is there a limit on how many scans can run at once?
      instructions:
      - text: Launch scan {scan_id}.
        slots:
          scan_id: path.scan_id
      - text: Launch scan {scan_id} against alternate targets {alt_targets}.
        slots:
          scan_id: path.scan_id
          alt_targets: requestBody.alt_targets
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scans/{scan_id}/pause'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause a running scan
      effect: write
      questions:
      - Can I pause a scan that's currently running?
      - Which scan statuses allow pausing?
      instructions:
      - text: Pause scan {scan_id}.
        slots:
          scan_id: path.scan_id
      - text: Temporarily halt running scan {scan_id}.
        slots:
          scan_id: path.scan_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scans/{scan_id}/resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a paused scan
      effect: write
      questions:
      - How do I continue a scan I paused earlier?
      - Can a scan be resumed if it isn't in paused status?
      instructions:
      - text: Resume scan {scan_id}.
        slots:
          scan_id: path.scan_id
      - text: Continue the paused scan {scan_id}.
        slots:
          scan_id: path.scan_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scans/{scan_id}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a scan
      effect: destructive
      questions:
      - Can I stop a scan that's pending or running?
      - What if a scan is stuck in stopping or publishing and a normal stop won't work?
      instructions:
      - text: Stop scan {scan_id}.
        slots:
          scan_id: path.scan_id
      - text: Gracefully stop the running scan {scan_id}.
        slots:
          scan_id: path.scan_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scans/{schedule_uuid}/force-stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Force stop a stuck scan
      effect: destructive
      questions:
      - Can I force a scan to abort and cancel its incomplete tasks?
      - Are completed scan tasks still kept after a force stop?
      instructions:
      - text: Force stop scan {schedule_uuid}.
        slots:
          schedule_uuid: path.schedule_uuid
      - text: Abort scan {schedule_uuid} and cancel all its unfinished tasks.
        slots:
          schedule_uuid: path.schedule_uuid
      method: generated
      generated: '2026-10-01'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/tenable-scan-control-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.