# 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 Tasks API
  version: 1.0.0
extends: openapi/tenable-agent-tasks-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['/scanners/null/agents/_bulk/{task_uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check status of a bulk agent task
      effect: read
      questions:
      - Has my asynchronous bulk agent task finished yet?
      - Can I track progress of a bulk operation that isn't tied to an agent group?
      instructions:
      - text: Check the status of bulk agent task {task_uuid}.
        slots:
          task_uuid: path.task_uuid
      - text: Tell me whether agent bulk job {task_uuid} has completed.
        slots:
          task_uuid: path.task_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/null/agent-groups/{group_id}/agents/_bulk/{task_uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check status of a bulk agent group task
      effect: read
      questions:
      - Is the bulk add or remove I started on an agent group done?
      - Where can I see progress of a bulk task scoped to one agent group?
      instructions:
      - text: Check the status of task {task_uuid} on agent group {group_id}.
        slots:
          task_uuid: path.task_uuid
          group_id: path.group_id
      - text: Show me progress of the bulk operation {task_uuid} for agent group {group_id}.
        slots:
          task_uuid: path.task_uuid
          group_id: path.group_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/null/agent-groups/{group_id}/agents/_bulk/add'].post
  update:
    x-apievangelist-phrasing:
      intent: Add agents to an agent group in bulk
      effect: write
      questions:
      - How do I add many agents to an agent group at once?
      - Can I add agents to a group by matching criteria instead of listing IDs?
      instructions:
      - text: Add agents {items} to agent group {group_id}.
        slots:
          items: requestBody.items
          group_id: path.group_id
      - text: Add every agent matching {criteria} to agent group {group_id}.
        slots:
          criteria: requestBody.criteria
          group_id: path.group_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/null/agent-groups/{group_id}/agents/_bulk/remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove agents from an agent group in bulk
      effect: write
      questions:
      - Can I pull a batch of agents out of an agent group in one request?
      - Is it possible to remove all agents matching a filter from a group except a few?
      instructions:
      - text: Remove agents {items} from agent group {group_id}.
        slots:
          items: requestBody.items
          group_id: path.group_id
      - text: Remove agents matching {criteria} from agent group {group_id}, except {not_items}.
        slots:
          criteria: requestBody.criteria
          group_id: path.group_id
          not_items: requestBody.not_items
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/null/agents/_bulk/addToNetwork'].post
  update:
    x-apievangelist-phrasing:
      intent: Move agents into a custom network
      effect: write
      questions:
      - How do I assign a set of agents to a custom network?
      - Can I move agents into a network by filter criteria?
      instructions:
      - text: Add agents {items} to network {network_uuid}.
        slots:
          items: requestBody.items
          network_uuid: requestBody.network_uuid
      - text: Move all agents matching {criteria} into custom network {network_uuid}.
        slots:
          criteria: requestBody.criteria
          network_uuid: requestBody.network_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/null/agents/_bulk/removeFromNetwork'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove agents from a custom network
      effect: write
      questions:
      - Where do agents go when I take them out of a custom network?
      - Can I remove a batch of agents from a network back to the Default network?
      instructions:
      - text: Remove agents {items} from network {network_uuid}.
        slots:
          items: requestBody.items
          network_uuid: requestBody.network_uuid
      - text: Send agents matching {criteria} in network {network_uuid} back to the Default network.
        slots:
          criteria: requestBody.criteria
          network_uuid: requestBody.network_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/null/agents/_bulk/assignToProfile'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign or remove agents from a profile
      effect: write
      questions:
      - Can I assign a batch of agents to an agent profile?
      - Is there a bulk way to take agents off an agent profile?
      instructions:
      - text: Assign the selected agents to an agent profile as a bulk task.
      - text: Remove the selected agents from their agent profile in bulk.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/null/agents/_bulk/directive'].post
  update:
    x-apievangelist-phrasing:
      intent: Send restart or settings instructions to agents
      effect: write
      questions:
      - Can I tell a set of agents to restart remotely?
      - What kinds of instructions can I push to agents across my whole fleet?
      instructions:
      - text: Send directive {directive} to agents {items}.
        slots:
          directive: requestBody.directive
          items: requestBody.items
      - text: Send instruction {directive} to all agents matching {criteria}.
        slots:
          directive: requestBody.directive
          criteria: requestBody.criteria
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/null/agent-groups/{group_id}/agents/_bulk/directive'].post
  update:
    x-apievangelist-phrasing:
      intent: Send instructions to agents in a group
      effect: write
      questions:
      - Can I restart only the agents in one agent group?
      - Is there a way to change local agent settings for a single agent group?
      instructions:
      - text: Send directive {directive} to every agent in group {group_id}.
        slots:
          directive: requestBody.directive
          group_id: path.group_id
      - text: Restart agents {items} in agent group {group_id} with directive {directive}.
        slots:
          items: requestBody.items
          group_id: path.group_id
          directive: requestBody.directive
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scanners/null/agents/_bulk/unlink'].post
  update:
    x-apievangelist-phrasing:
      intent: Unlink agents in bulk
      effect: destructive
      questions:
      - How do I unlink a batch of agents from my container?
      - What happens to data from agents after they are unlinked?
      instructions:
      - text: Unlink agents {items}.
        slots:
          items: requestBody.items
      - text: Unlink every agent matching {criteria}.
        slots:
          criteria: requestBody.criteria
      method: generated
      generated: '2026-10-01'