Tenable · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Tenable Platform & Settings Networks API
11 actions
11 updates
phrasing
extends
openapi/tenable-networks-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.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/networks'].get
$.paths['/networks'].post
$.paths['/networks/{network_id}'].get
$.paths['/networks/{network_id}'].put
$.paths['/networks/{network_id}'].delete
$.paths['/networks/{network_id}/counts/assets-not-seen-in/{num_days}'].get
$.paths['/networks/{network_id}/scanners/{scanner_uuid}'].post
$.paths['/networks/{network_id}/scanners'].get
$.paths['/networks/{network_id}/scanners'].post
$.paths['/networks/{network_id}/assignable-scanners'].get
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 Networks API
version: 1.0.0
extends: openapi/tenable-networks-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: 10
- target: $.paths['/networks'].get
update:
x-apievangelist-phrasing:
intent: List network objects
effect: read
questions:
- What network objects are set up in my Tenable organization?
- Can I include deleted networks when listing them?
instructions:
- text: List all my network objects.
- text: 'List networks including deleted ones: {includeDeleted}.'
slots:
includeDeleted: query.includeDeleted
method: generated
generated: '2026-10-01'
- target: $.paths['/networks'].post
update:
x-apievangelist-phrasing:
intent: Create a network object
effect: write
questions:
- How do I create a network to separate overlapping IP ranges?
- Can I set how many days assets live in a new network before they age out?
- Can AWS assets be placed into a network object?
instructions:
- text: Create a network named {name}.
slots:
name: requestBody.name
- text: Create network {name} with an asset age-out of {assets_ttl_days} days.
slots:
name: requestBody.name
assets_ttl_days: requestBody.assets_ttl_days
method: generated
generated: '2026-10-01'
- target: $.paths['/networks/{network_id}'].get
update:
x-apievangelist-phrasing:
intent: Get details of a network
effect: read
questions:
- What settings does a specific network object have?
- Can I look up one network by its ID?
instructions:
- text: Get the details of network {network_id}.
slots:
network_id: path.network_id
- text: Show me the name and asset TTL of network {network_id}.
slots:
network_id: path.network_id
method: generated
generated: '2026-10-01'
- target: $.paths['/networks/{network_id}'].put
update:
x-apievangelist-phrasing:
intent: Update a network's name or settings
effect: write
questions:
- Can I rename an existing network object?
- Do I need to resend the name when I only change a network's description?
instructions:
- text: Rename network {network_id} to {name}.
slots:
network_id: path.network_id
name: requestBody.name
- text: Update network {network_id} named {name} to age out assets after {assets_ttl_days} days.
slots:
network_id: path.network_id
name: requestBody.name
assets_ttl_days: requestBody.assets_ttl_days
method: generated
generated: '2026-10-01'
- target: $.paths['/networks/{network_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a network object
effect: destructive
questions:
- What should I do with assets before deleting a network?
- Can I delete a custom network I no longer need?
instructions:
- text: Delete network {network_id}.
slots:
network_id: path.network_id
- text: Remove the custom network object {network_id}.
slots:
network_id: path.network_id
method: generated
generated: '2026-10-01'
- target: $.paths['/networks/{network_id}/counts/assets-not-seen-in/{num_days}'].get
update:
x-apievangelist-phrasing:
intent: Count stale assets in a network
effect: read
questions:
- How many assets in a network haven't been seen in the last 30 days?
- What's the total asset count for a given network?
instructions:
- text: Count assets in network {network_id} not seen in {num_days} days.
slots:
network_id: path.network_id
num_days: path.num_days
- text: Give me the total and stale asset counts for network {network_id} over {num_days} days.
slots:
network_id: path.network_id
num_days: path.num_days
method: generated
generated: '2026-10-01'
- target: $.paths['/networks/{network_id}/scanners/{scanner_uuid}'].post
update:
x-apievangelist-phrasing:
intent: Assign one scanner to a network
effect: write
questions:
- How do I put a single scanner or scanner group into a custom network?
- Can I return a scanner to the default network?
instructions:
- text: Assign scanner {scanner_uuid} to network {network_id}.
slots:
scanner_uuid: path.scanner_uuid
network_id: path.network_id
- text: Move scanner group {scanner_uuid} into network {network_id}.
slots:
scanner_uuid: path.scanner_uuid
network_id: path.network_id
method: generated
generated: '2026-10-01'
- target: $.paths['/networks/{network_id}/scanners'].get
update:
x-apievangelist-phrasing:
intent: List scanners in a network
effect: read
questions:
- Which scanners and scanner groups belong to a given network?
- What sensors are currently assigned to my custom network?
instructions:
- text: List scanners assigned to network {network_id}.
slots:
network_id: path.network_id
- text: Show me the scanner groups in network {network_id}.
slots:
network_id: path.network_id
method: generated
generated: '2026-10-01'
- target: $.paths['/networks/{network_id}/scanners'].post
update:
x-apievangelist-phrasing:
intent: Replace a network's scanner assignments
effect: write
questions:
- Can I set the full list of scanners for a network in one call?
- Does bulk assigning scanners overwrite the ones already in the network?
instructions:
- text: Set the scanners for network {network_id} to {scanner_uuids}.
slots:
network_id: path.network_id
scanner_uuids: requestBody.scanner_uuids
- text: Bulk assign scanners {scanner_uuids} to network {network_id}, replacing the current list.
slots:
scanner_uuids: requestBody.scanner_uuids
network_id: path.network_id
method: generated
generated: '2026-10-01'
- target: $.paths['/networks/{network_id}/assignable-scanners'].get
update:
x-apievangelist-phrasing:
intent: List scanners available to add to a network
effect: read
questions:
- Which scanners aren't assigned to any custom network yet?
- What scanners could I still add to this network?
instructions:
- text: List scanners I can assign to network {network_id}.
slots:
network_id: path.network_id
- text: Show unassigned scanners and groups available for network {network_id}.
slots:
network_id: path.network_id
method: generated
generated: '2026-10-01'