Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tenable Platform & Settings Agents API

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

$.info

$.paths['/scanners/null/agents'].get

$.paths['/scanners/null/agent-groups/{agent_group_id}/agents'].get

$.paths['/agents/safe-mode-summary'].get

$.paths['/scanners/null/agents/{agent_id}'].get

$.paths['/scanners/null/agents/{agent_id}'].delete

$.paths['/scanners/null/agents/{agent_id}'].patch

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 Tenable Platform & Settings Agents API
  version: 1.0.0
extends: openapi/tenable-agents-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: 6
- target: $.paths['/scanners/null/agents'].get
  update:
    x-apievangelist-phrasing:
      intent: List linked agents
      effect: read
      questions:
      - Which Nessus agents are linked to my account?
      - Can I filter agents by platform or search them with a wildcard?
      instructions:
      - text: List all my linked agents.
      - text: List agents matching filter {f}, sorted by {sort}, limit {limit}.
        slots:
          f: query.f
          sort: query.sort
          limit: query.limit
      - text: Find agents whose fields contain {w}.
        slots:
          w: query.w
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/null/agent-groups/{agent_group_id}/agents'].get
  update:
    x-apievangelist-phrasing:
      intent: List the agents in a group
      effect: read
      questions:
      - Which agents belong to a specific agent group?
      - Can I page through a group's agents with a filter?
      instructions:
      - text: List the agents in agent group {agent_group_id}.
        slots:
          agent_group_id: path.agent_group_id
      - text: List agents in group {agent_group_id} matching {f}, {limit} at a time from offset {offset}.
        slots:
          agent_group_id: path.agent_group_id
          f: query.f
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/agents/safe-mode-summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize agents in safe mode
      effect: read
      questions:
      - How many of my agents are running in safe mode?
      - Which agent versions and operating systems are in safe mode?
      instructions:
      - text: Give me a summary of agents in safe mode.
      - text: Break down safe-mode agents by version and platform.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/null/agents/{agent_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an agent's details
      effect: read
      questions:
      - What platform, version and status does a particular agent report?
      - When did a specific agent last connect?
      instructions:
      - text: Show details for agent {agent_id}.
        slots:
          agent_id: path.agent_id
      - text: Look up agent {agent_id} and report its status.
        slots:
          agent_id: path.agent_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/null/agents/{agent_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink an agent
      effect: destructive
      questions:
      - How do I unlink an agent from my account?
      - What happens to an agent's data after it is unlinked?
      instructions:
      - text: Unlink agent {agent_id}.
        slots:
          agent_id: path.agent_id
      - text: Disconnect agent {agent_id} from Tenable Vulnerability Management.
        slots:
          agent_id: path.agent_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/null/agents/{agent_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename an agent
      effect: write
      questions:
      - Can I give an agent a friendlier name?
      - How do I change the display name of a linked agent?
      instructions:
      - text: Rename agent {agent_id} to {name}.
        slots:
          agent_id: path.agent_id
          name: requestBody.name
      - text: Change agent {agent_id}'s name to {name}.
        slots:
          agent_id: path.agent_id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'