Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity Exposure Syslog API

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

$.info
$.paths['/api/syslogs'].get
$.paths['/api/syslogs'].post
$.paths['/api/syslogs/{id}'].get
$.paths['/api/syslogs/{id}'].delete
$.paths['/api/syslogs/{id}'].patch
$.paths['/api/syslogs/test-message/{id}'].get
$.paths['/api/syslogs/test-message'].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 Identity Exposure Syslog API
  version: 1.0.0
extends: openapi/tenable-syslog-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: 7
- target: $.paths['/api/syslogs'].get
  update:
    x-apievangelist-phrasing:
      intent: List syslog forwarders
      effect: read
      questions:
      - Where is Identity Exposure forwarding syslog alerts?
      - Can I list all syslog configurations?
      instructions:
      - text: List syslog forwarders.
      - text: Show every syslog destination.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/syslogs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a syslog forwarder
      effect: write
      questions:
      - How do I send alerts to my SIEM over syslog?
      - Can I add a new syslog destination?
      instructions:
      - text: Create a syslog forwarder.
      - text: Add a new syslog destination for alerts.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/syslogs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a syslog forwarder
      effect: read
      questions:
      - What host and port does a syslog forwarder send to?
      - How do I view one syslog configuration?
      instructions:
      - text: Get syslog forwarder {id}.
        slots:
          id: path.id
      - text: Show settings of syslog destination {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/syslogs/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a syslog forwarder
      effect: destructive
      questions:
      - How do I stop forwarding to a syslog server?
      - Can I remove a syslog destination?
      instructions:
      - text: Delete syslog forwarder {id}.
        slots:
          id: path.id
      - text: Remove syslog destination {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/syslogs/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a syslog forwarder
      effect: write
      questions:
      - Can I change the IP and port a syslog forwarder targets?
      - How do I switch a syslog destination to TCP with TLS?
      instructions:
      - text: Point syslog forwarder {id} at {ip} port {port}.
        slots:
          id: path.id
          ip: requestBody.ip
          port: requestBody.port
      - text: Set protocol {protocol} with TLS {tls} on syslog forwarder {id}.
        slots:
          protocol: requestBody.protocol
          tls: requestBody.tls
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/syslogs/test-message/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Send a test syslog for a saved forwarder
      effect: write
      questions:
      - How do I confirm an existing syslog forwarder reaches my SIEM?
      - Can I send a test message from a saved syslog configuration?
      instructions:
      - text: Send a test syslog message from forwarder {id}.
        slots:
          id: path.id
      - text: Trigger a test on saved syslog destination {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/syslogs/test-message'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test syslog before saving
      effect: write
      questions:
      - Can I test syslog settings before creating the forwarder?
      - Will a syslog message reach a host with these protocol and TLS settings?
      instructions:
      - text: Send a test syslog to {ip}:{port} over {protocol}, TLS {tls}, threshold {criticityThreshold}, directories {directories}, input {inputType}.
        slots:
          ip: requestBody.ip
          port: requestBody.port
          protocol: requestBody.protocol
          tls: requestBody.tls
          criticityThreshold: requestBody.criticityThreshold
          directories: requestBody.directories
          inputType: requestBody.inputType
      - text: Try unsaved syslog settings against host {ip} via relay {relayId}.
        slots:
          ip: requestBody.ip
          relayId: requestBody.relayId
      method: generated
      generated: '2026-10-01'