Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tenable Platform & Settings Agent Exclusions API

6 actions 6 updates phrasing extends openapi/tenable-agent-exclusions-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['/scanners/null/agents/exclusions'].get
$.paths['/scanners/null/agents/exclusions'].post
$.paths['/scanners/null/agents/exclusions/{exclusion_id}'].get
$.paths['/scanners/null/agents/exclusions/{exclusion_id}'].put
$.paths['/scanners/null/agents/exclusions/{exclusion_id}'].delete

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 Tenable Platform & Settings Agent Exclusions API
  version: 1.0.0
extends: openapi/tenable-agent-exclusions-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['/scanners/null/agents/exclusions'].get
  update:
    x-apievangelist-phrasing:
      intent: List agent exclusions
      effect: read
      questions:
      - Which blackout windows are set to stop agents from scanning?
      - What agent exclusions are currently in place?
      instructions:
      - text: List all agent exclusions.
      - text: Show me the current agent blackout windows.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/null/agents/exclusions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an agent exclusion window
      effect: write
      questions:
      - How do I stop agents from scanning during a maintenance window?
      - Can an agent exclusion repeat on a schedule?
      instructions:
      - text: Create an agent exclusion {name} with schedule {schedule}.
        slots:
          name: requestBody.name
          schedule: requestBody.schedule
      - text: Add agent blackout {name} ({description}) on schedule {schedule}.
        slots:
          name: requestBody.name
          description: requestBody.description
          schedule: requestBody.schedule
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/null/agents/exclusions/{exclusion_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an agent exclusion's details
      effect: read
      questions:
      - What schedule does a specific agent exclusion follow?
      - Can I look up one agent exclusion by ID?
      instructions:
      - text: Show agent exclusion {exclusion_id}.
        slots:
          exclusion_id: path.exclusion_id
      - text: Get the schedule of agent exclusion {exclusion_id}.
        slots:
          exclusion_id: path.exclusion_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/null/agents/exclusions/{exclusion_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an agent exclusion
      effect: write
      questions:
      - How do I change the timing of an existing agent blackout window?
      - Can I rename an agent exclusion?
      instructions:
      - text: Change the schedule of agent exclusion {exclusion_id} to {schedule}.
        slots:
          exclusion_id: path.exclusion_id
          schedule: requestBody.schedule
      - text: Rename agent exclusion {exclusion_id} to {name} keeping schedule {schedule}.
        slots:
          exclusion_id: path.exclusion_id
          name: requestBody.name
          schedule: requestBody.schedule
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/null/agents/exclusions/{exclusion_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an agent exclusion
      effect: destructive
      questions:
      - How do I delete an agent blackout window?
      - Can I remove an agent exclusion so agents scan again?
      instructions:
      - text: Delete agent exclusion {exclusion_id}.
        slots:
          exclusion_id: path.exclusion_id
      - text: Remove the agent blackout {exclusion_id}.
        slots:
          exclusion_id: path.exclusion_id
      method: generated
      generated: '2026-10-01'