Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for MSSP Portal Domains API

6 actions 6 updates phrasing extends openapi/tenable-domains-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['/mssp/domains'].get
$.paths['/mssp/domains'].post
$.paths['/mssp/domains/account/{account_uuid}'].get
$.paths['/mssp/domains/account/{account_uuid}'].put
$.paths['/mssp/domains/verifyDomain'].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 MSSP Portal Domains API
  version: 1.0.0
extends: openapi/tenable-domains-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['/mssp/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List child containers and their domains
      effect: read
      questions:
      - Which domains are attached to my MSSP child containers?
      - Can I see every customer container and its domains in one list?
      instructions:
      - text: List all child containers and their domains.
      - text: Show me every MSSP domain across customer containers.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/mssp/domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a domain to a container
      effect: write
      questions:
      - How do I add a domain to a customer container once I have the activation code?
      - What do I need to supply to attach a new domain?
      instructions:
      - text: Add domain {domain_name} to container {container_uuid} with activation code {activation_code}.
        slots:
          domain_name: requestBody.domain_name
          container_uuid: requestBody.container_uuid
          activation_code: requestBody.activation_code
      - text: Attach {domain_name} to container {container_uuid} using code {activation_code}.
        slots:
          domain_name: requestBody.domain_name
          container_uuid: requestBody.container_uuid
          activation_code: requestBody.activation_code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/mssp/domains/account/{account_uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get domains for a customer account
      effect: read
      questions:
      - Which domains belong to a particular customer account?
      - What is the status of the domains on one MSSP account?
      instructions:
      - text: List the domains for account {account_uuid}.
        slots:
          account_uuid: path.account_uuid
      - text: Show domain details for customer account {account_uuid}.
        slots:
          account_uuid: path.account_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/mssp/domains/account/{account_uuid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a customer account's domain
      effect: write
      questions:
      - How do I change a domain's status on a customer account?
      - Can I update the domain type for an MSSP account?
      instructions:
      - text: Set the status of domain {domain_name} on account {account_uuid} to {status}.
        slots:
          domain_name: requestBody.domain_name
          account_uuid: path.account_uuid
          status: requestBody.status
      - text: Change the domain type on account {account_uuid} to {type}.
        slots:
          account_uuid: path.account_uuid
          type: requestBody.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/mssp/domains/verifyDomain'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a domain activation code
      effect: write
      questions:
      - How do I get the verification code needed to add a domain to a container?
      - Can I resend a domain activation code that never arrived?
      instructions:
      - text: Send an activation code to add {domain_name} (host {host_name}) to container {container_uuid}.
        slots:
          domain_name: requestBody.domain_name
          host_name: requestBody.host_name
          container_uuid: requestBody.container_uuid
      - text: Resend ({is_resend}) the code for {domain_name} on host {host_name}, container {container_uuid}.
        slots:
          is_resend: requestBody.is_resend
          domain_name: requestBody.domain_name
          host_name: requestBody.host_name
          container_uuid: requestBody.container_uuid
      method: generated
      generated: '2026-10-01'