Acronis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Acronis Agents API

6 actions 6 updates phrasing extends openapi/acronis-agents-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Acronis's API. It is a proposal applied on top of the contract, not a document Acronis publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/agents'].get

$.paths['/agents'].delete

$.paths['/agents/update:force'].post

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

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

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 Acronis Agents API
  version: 1.0.0
extends: openapi/acronis-agents-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/agents'].get
  update:
    x-apievangelist-phrasing:
      intent: List registered agents
      effect: read
      questions:
      - How do I list every protection agent registered under my tenant and its children?
      - Can I find agents that are offline or running outdated software?
      - Which agents are installed on Linux machines?
      instructions:
      - text: List agents in tenant {tenant_id}.
        slots:
          tenant_id: query.tenant_id
      - text: Find agents whose hostname matches {hostname}.
        slots:
          hostname: query.hostname
      - text: Show agents with OS family {os_family} that are not up to date.
        slots:
          os_family: query.os_family
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unregister agents
      effect: destructive
      questions:
      - Can I unregister agents and remove their service accounts in one call?
      - What does forcing an agent unregistration do?
      instructions:
      - text: Unregister agents {id}.
        slots:
          id: query.id
      - text: Force-cancel registration of agents {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/update:force'].post
  update:
    x-apievangelist-phrasing:
      intent: Update agents immediately
      effect: write
      questions:
      - How do I push an agent update right now, ignoring the maintenance window?
      - What happens if I start an update without listing any agent IDs?
      instructions:
      - text: Update agents {agent_ids} now.
        slots:
          agent_ids: requestBody.agent_ids
      - text: Force an immediate update of all my tenant's agents.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agent_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one registered agent
      effect: read
      questions:
      - How can I see the details of a single agent?
      - Is this particular agent online and on the current version?
      instructions:
      - text: Show agent {agent_id}.
        slots:
          agent_id: path.agent_id
      - text: Get details for registered agent {agent_id}.
        slots:
          agent_id: path.agent_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/{agent_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unregister one agent
      effect: destructive
      questions:
      - How do I unregister a single agent from the platform?
      - Does removing one agent also delete its service account?
      instructions:
      - text: Unregister agent {agent_id}.
        slots:
          agent_id: path.agent_id
      - text: Force-remove the registration of agent {agent_id}.
        slots:
          agent_id: path.agent_id
      method: generated
      generated: '2026-09-26'