API Evangelist conversational phrasing for Vault Manager Vaults API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Vault Manager Vaults API
  version: 1.0.0
extends: openapi/acronis-vaults-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: 28
- target: $.paths['/vaults'].get
  update:
    x-apievangelist-phrasing:
      intent: List backup vaults
      effect: read
      questions:
      - How do I see every backup vault registered on a given host?
      - Can I filter the vault list by storage node or vault type?
      - Which Acronis vaults are accessible for a particular agent, with their last backup time?
      instructions:
      - text: List the backup vaults on host {hostname}.
        slots:
          hostname: query.hostname
      - text: List vaults on host {hostname} attached to storage node {storageNodeId}.
        slots:
          hostname: query.hostname
          storageNodeId: query.storageNodeId
      - text: Show vaults on {hostname} named {name}, including storage stats.
        slots:
          hostname: query.hostname
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or attach a backup vault
      effect: write
      questions:
      - How do I add a new backup location as a vault?
      - Can I attach an existing storage location as a vault instead of creating a fresh one?
      - What happens if the agents fail to run the vault creation command?
      instructions:
      - text: Attach an existing vault with action {action} and config {config}.
        slots:
          action: requestBody.action
          config: requestBody.config
      - text: Create a new vault using config {config} and credentials {credentials_id}, action {action}.
        slots:
          config: requestBody.config
          credentials_id: requestBody.credentials_id
          action: requestBody.action
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/refresh'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh vault contents on agents
      effect: write
      questions:
      - How do I make agents rescan my vaults so new archives show up?
      - Can I refresh only certain vaults rather than all of them?
      instructions:
      - text: Refresh vaults {vault_ids}.
        slots:
          vault_ids: requestBody.vault_ids
      - text: Have agent {target_agent_id} refresh vaults {vault_ids}, including immutable archives.
        slots:
          target_agent_id: requestBody.target_agent_id
          vault_ids: requestBody.vault_ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one backup vault
      effect: read
      questions:
      - How do I look up the details of a single vault by its ID?
      - Can I see a specific vault's storage statistics and last backup time?
      instructions:
      - text: Show vault {vaultID}.
        slots:
          vaultID: path.vaultID
      - text: Get vault {vaultID} with its storage stats and last backup time.
        slots:
          vaultID: path.vaultID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove or detach a backup vault
      effect: destructive
      questions:
      - How do I detach a vault I no longer want to back up to?
      - Is it possible to unregister a vault for one tenant only?
      instructions:
      - text: Delete vault {vaultID}.
        slots:
          vaultID: path.vaultID
      - text: Detach vault {vaultID} for tenant {tenantID}.
        slots:
          vaultID: path.vaultID
          tenantID: query.tenantID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}/archives'].get
  update:
    x-apievangelist-phrasing:
      intent: List archives in a vault
      effect: read
      questions:
      - What backup archives are stored in a particular vault?
      - Can I list only the archives in a vault where malware was found?
      - How do I find a vault's archives for one backup plan between two dates?
      instructions:
      - text: List archives in vault {vaultID}.
        slots:
          vaultID: path.vaultID
      - text: List archives in vault {vaultID} for backup plan {backupPlanId}.
        slots:
          vaultID: path.vaultID
          backupPlanId: query.backupPlanId
      - text: Show archives in vault {vaultID} for resource {resourceId} created after {fromDate}.
        slots:
          vaultID: path.vaultID
          resourceId: query.resourceId
          fromDate: query.fromDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}/archives'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete archives from a vault
      effect: destructive
      questions:
      - How do I permanently remove whole archives from a vault?
      - What change tag do I need to delete archives from a vault?
      instructions:
      - text: Delete archive {archiveId} from vault {vaultID} using change tag {changeTag}.
        slots:
          archiveId: query.archiveId
          vaultID: path.vaultID
          changeTag: query.changeTag
      - text: Remove archive {archiveId} from vault {vaultID} through agent {targetAgentId}, change tag {changeTag}.
        slots:
          archiveId: query.archiveId
          vaultID: path.vaultID
          targetAgentId: query.targetAgentId
          changeTag: query.changeTag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}/archives/refresh'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh specific archives in a vault
      effect: write
      questions:
      - How do I rescan just a few archives in a vault instead of the whole vault?
      - Can I choose which agent refreshes the archives in a vault?
      instructions:
      - text: Refresh archives {archive_ids} in vault {vaultID}.
        slots:
          archive_ids: requestBody.archive_ids
          vaultID: path.vaultID
      - text: Have agent {target_agent_id} refresh archives {archive_ids} in vault {vaultID}.
        slots:
          target_agent_id: requestBody.target_agent_id
          archive_ids: requestBody.archive_ids
          vaultID: path.vaultID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one backup from a vault archive
      effect: read
      questions:
      - How do I view the details of a single backup inside an archive?
      - Can I still retrieve a backup record that was already deleted?
      instructions:
      - text: Show backup {backupID} in archive {archiveID} of vault {vaultID}.
        slots:
          backupID: path.backupID
          archiveID: path.archiveID
          vaultID: path.vaultID
      - text: Get backup {backupID} from archive {archiveID} in vault {vaultID}, even if it was deleted.
        slots:
          backupID: path.backupID
          archiveID: path.archiveID
          vaultID: path.vaultID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}/validation_status'].put
  update:
    x-apievangelist-phrasing:
      intent: Record backup validation results
      effect: write
      questions:
      - How do I write the outcome of a backup validation plan back to a backup?
      - Can I record checksum and VM heartbeat validation results for a backup?
      instructions:
      - text: Set checksum validation {checksum_validation} on backup {backupID} in archive {archiveID}, vault {vaultID}.
        slots:
          checksum_validation: requestBody.checksum_validation
          backupID: path.backupID
          archiveID: path.archiveID
          vaultID: path.vaultID
      - text: Record heartbeat result {vm_heartbeat_validation} for backup {backupID} in archive {archiveID} of vault {vaultID}.
        slots:
          vm_heartbeat_validation: requestBody.vm_heartbeat_validation
          backupID: path.backupID
          archiveID: path.archiveID
          vaultID: path.vaultID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}/validation_status/screenshot_full'].get
  update:
    x-apievangelist-phrasing:
      intent: Get full validation screenshot of a backup
      effect: read
      questions:
      - Where can I see the full-size screenshot captured when a backup was validated?
      - Can I download the complete validation screenshot, not just the thumbnail?
      instructions:
      - text: Get the full validation screenshot for backup {backupID} in archive {archiveID}, vault {vaultID}.
        slots:
          backupID: path.backupID
          archiveID: path.archiveID
          vaultID: path.vaultID
      - text: Download the full-size screenshot the validation plan took of backup {backupID} (archive {archiveID}, vault {vaultID}).
        slots:
          backupID: path.backupID
          archiveID: path.archiveID
          vaultID: path.vaultID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}/validation_status/screenshot_preview'].get
  update:
    x-apievangelist-phrasing:
      intent: Get validation screenshot preview of a backup
      effect: read
      questions:
      - How do I get a small preview of the screenshot from backup validation?
      - Is there a thumbnail of the validation screenshot for a backup?
      instructions:
      - text: Get the validation screenshot thumbnail for backup {backupID} in archive {archiveID}, vault {vaultID}.
        slots:
          backupID: path.backupID
          archiveID: path.archiveID
          vaultID: path.vaultID
      - text: Show the small validation-plan preview image for backup {backupID} (archive {archiveID}, vault {vaultID}).
        slots:
          backupID: path.backupID
          archiveID: path.archiveID
          vaultID: path.vaultID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}/automated_test_failover_validation_status'].put
  update:
    x-apievangelist-phrasing:
      intent: Record automated test failover result
      effect: write
      questions:
      - How do I save the result of an automated test failover for a backup?
      - What timestamps and status are needed to log an ATF validation?
      instructions:
      - text: Record ATF status {overall_status} for backup {backupID} in archive {archiveID}, vault {vaultID}, task {task_id}, from {started_at} to {completed_at}.
        slots:
          overall_status: requestBody.overall_status
          backupID: path.backupID
          archiveID: path.archiveID
          vaultID: path.vaultID
          task_id: requestBody.task_id
          started_at: requestBody.started_at
          completed_at: requestBody.completed_at
      - text: Log ATF {overall_status} for backup {backupID}/{archiveID}/{vaultID}, task {task_id}, {started_at}-{completed_at}, image {screenshot_full_url}.
        slots:
          overall_status: requestBody.overall_status
          backupID: path.backupID
          archiveID: path.archiveID
          vaultID: path.vaultID
          task_id: requestBody.task_id
          started_at: requestBody.started_at
          completed_at: requestBody.completed_at
          screenshot_full_url: requestBody.screenshot_full_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}/automated_test_failover_validation_status/screenshot_full'].get
  update:
    x-apievangelist-phrasing:
      intent: Get full test failover screenshot
      effect: read
      questions:
      - Where do I find the full-size screenshot from an automated test failover?
      - Can I see what the VM looked like during the ATF run at full resolution?
      instructions:
      - text: Get the full automated test failover screenshot for backup {backupID} in archive {archiveID}, vault {vaultID}.
        slots:
          backupID: path.backupID
          archiveID: path.archiveID
          vaultID: path.vaultID
      - text: Download the full-size ATF screenshot of backup {backupID} (archive {archiveID}, vault {vaultID}).
        slots:
          backupID: path.backupID
          archiveID: path.archiveID
          vaultID: path.vaultID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}/automated_test_failover_validation_status/screenshot_preview'].get
  update:
    x-apievangelist-phrasing:
      intent: Get test failover screenshot preview
      effect: read
      questions:
      - How do I get the preview image from an automated test failover?
      - Is there a thumbnail of the ATF screenshot for a backup?
      instructions:
      - text: Get the ATF screenshot thumbnail for backup {backupID} in archive {archiveID}, vault {vaultID}.
        slots:
          backupID: path.backupID
          archiveID: path.archiveID
          vaultID: path.vaultID
      - text: Show the small test-failover preview image for backup {backupID} (archive {archiveID}, vault {vaultID}).
        slots:
          backupID: path.backupID
          archiveID: path.archiveID
          vaultID: path.vaultID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}/archives/{archiveID}/backup_timestamps'].get
  update:
    x-apievangelist-phrasing:
      intent: List when backups in an archive were made
      effect: read
      questions:
      - When were the backups in a given archive taken?
      - Can I group backup times by hour instead of by day?
      - How do I shift backup timestamps into my time zone?
      instructions:
      - text: List backup timestamps for archive {archiveID} in vault {vaultID}.
        slots:
          archiveID: path.archiveID
          vaultID: path.vaultID
      - text: Show backup times for archive {archiveID} in vault {vaultID} grouped by {granularity}.
        slots:
          archiveID: path.archiveID
          vaultID: path.vaultID
          granularity: query.granularity
      - text: List backup times in archive {archiveID}, vault {vaultID}, with time zone offset {tzOffset}.
        slots:
          archiveID: path.archiveID
          vaultID: path.vaultID
          tzOffset: query.tzOffset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}/archives/{archiveID}/backups'].get
  update:
    x-apievangelist-phrasing:
      intent: List backups in a vault archive
      effect: read
      questions:
      - What backups exist inside a specific archive?
      - Can I list only password-protected backups in an archive?
      - How do I find backups in an archive where malware assessment flagged something?
      instructions:
      - text: List backups in archive {archiveID} of vault {vaultID}.
        slots:
          archiveID: path.archiveID
          vaultID: path.vaultID
      - text: List {backupType} backups in archive {archiveID}, vault {vaultID}.
        slots:
          backupType: query.backupType
          archiveID: path.archiveID
          vaultID: path.vaultID
      - text: Show backups in archive {archiveID}, vault {vaultID} with malware status {malwareAssessmentStatus}.
        slots:
          archiveID: path.archiveID
          vaultID: path.vaultID
          malwareAssessmentStatus: query.malwareAssessmentStatus
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}/archives/{archiveID}/backups'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete backups from an archive directly
      effect: destructive
      questions:
      - How do I delete specific backups from an archive right away with a DELETE call?
      - Which change tag is required to remove backups from an archive?
      instructions:
      - text: Delete backup {backupId} from archive {archiveID} in vault {vaultID} with change tag {changeTag}.
        slots:
          backupId: query.backupId
          archiveID: path.archiveID
          vaultID: path.vaultID
          changeTag: query.changeTag
      - text: Remove backup {backupId} from archive {archiveID}, vault {vaultID} for tenant {tenantId}, change tag {changeTag}.
        slots:
          backupId: query.backupId
          archiveID: path.archiveID
          vaultID: path.vaultID
          tenantId: query.tenantId
          changeTag: query.changeTag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}/archives/{archiveID}/backups/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue backup deletion tasks on an agent
      effect: destructive
      questions:
      - Can I hand backup deletion off to an agent as a task, supplying the archive password?
      - How do I delete backups in a password-protected archive through an agent?
      instructions:
      - text: Queue deletion of backup {backupID} in archive {archiveID}, vault {vaultID} on agent {target_agent_id}.
        slots:
          backupID: query.backupID
          archiveID: path.archiveID
          vaultID: path.vaultID
          target_agent_id: requestBody.target_agent_id
      - text: Create an agent task deleting backups in archive {archiveID}, vault {vaultID}, archive password {password}.
        slots:
          archiveID: path.archiveID
          vaultID: path.vaultID
          password: requestBody.password
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}/archives/{archiveID}/replication_status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check archive geo-replication status
      effect: read
      questions:
      - Is my archive replicated to the secondary geographic location yet?
      - How do I check geo-replication progress for one archive?
      instructions:
      - text: Show geo-replication status for archive {archiveID} in vault {vaultID}.
        slots:
          archiveID: path.archiveID
          vaultID: path.vaultID
      - text: Check whether archive {archiveID} in vault {vaultID} has finished replicating to its second location.
        slots:
          archiveID: path.archiveID
          vaultID: path.vaultID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a vault's configuration
      effect: read
      questions:
      - How do I view a vault's name, access address and settings?
      - What hostname is a vault configured with?
      instructions:
      - text: Show the configuration of vault {vaultID}.
        slots:
          vaultID: path.vaultID
      - text: Get the name, access address and hostname configured for vault {vaultID}.
        slots:
          vaultID: path.vaultID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}/config'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a vault's configuration
      effect: write
      questions:
      - How do I rename a vault or change its access address?
      - Can I update the hostname a vault is reached at?
      instructions:
      - text: Rename vault {vaultID} to {name}.
        slots:
          vaultID: path.vaultID
          name: requestBody.name
      - text: Set the access address of vault {vaultID} to {access_address}.
        slots:
          vaultID: path.vaultID
          access_address: requestBody.access_address
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a vault's storage statistics
      effect: read
      questions:
      - How much space is a vault using, and how many backups does it hold?
      - What is the deduplication ratio for a vault?
      instructions:
      - text: Show storage statistics for vault {vaultID}.
        slots:
          vaultID: path.vaultID
      - text: Get the occupied, free and total space for vault {vaultID}.
        slots:
          vaultID: path.vaultID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}/stats'].post
  update:
    x-apievangelist-phrasing:
      intent: Report updated vault statistics
      effect: write
      questions:
      - How do I push new archive and backup counts for a vault?
      - Can I report a vault's free and total space figures?
      instructions:
      - text: 'Update vault {vaultID} stats: {archive_count} archives, {backup_count} backups.'
        slots:
          vaultID: path.vaultID
          archive_count: requestBody.archive_count
          backup_count: requestBody.backup_count
      - text: Record free space {free_space} of total {total_space} for vault {vaultID}.
        slots:
          free_space: requestBody.free_space
          total_space: requestBody.total_space
          vaultID: path.vaultID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}/agents'].get
  update:
    x-apievangelist-phrasing:
      intent: List agents managing a vault
      effect: read
      questions:
      - Which agents manage a particular vault?
      - How do I find out what machines can access a vault?
      instructions:
      - text: List the agents that manage vault {vaultID}.
        slots:
          vaultID: path.vaultID
      - text: Show which machines can reach vault {vaultID} as managing agents.
        slots:
          vaultID: path.vaultID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}/change_password'].post
  update:
    x-apievangelist-phrasing:
      intent: Change an encrypted vault's password
      effect: write
      questions:
      - How do I change the password on an encrypted vault in an on-premises deployment?
      - What old and new vault URIs do I need to change the encryption password?
      instructions:
      - text: Change the password of encrypted vault {vaultID} from {uri_old} to {uri_new} in session {session_id}.
        slots:
          vaultID: path.vaultID
          uri_old: requestBody.uri_old
          uri_new: requestBody.uri_new
          session_id: requestBody.session_id
      - text: 'Rotate the encryption password on on-prem vault {vaultID}: old {uri_old}, new {uri_new}, session {session_id}.'
        slots:
          vaultID: path.vaultID
          uri_old: requestBody.uri_old
          uri_new: requestBody.uri_new
          session_id: requestBody.session_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}/change_credentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a managed vault's access credentials
      effect: write
      questions:
      - How do I update the login credentials a managed vault uses on-premises?
      - Can I point a managed vault at new credentials without recreating it?
      instructions:
      - text: Change access credentials for managed vault {vaultID} to {uri} in session {session_id}.
        slots:
          vaultID: path.vaultID
          uri: requestBody.uri
          session_id: requestBody.session_id
      - text: Update the storage login used by on-prem managed vault {vaultID} to {uri}, session {session_id}.
        slots:
          vaultID: path.vaultID
          uri: requestBody.uri
          session_id: requestBody.session_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/vaults/{vaultID}/replace_vault_password'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace a forgotten encrypted vault password
      effect: write
      questions:
      - Can I replace an encrypted vault's password without supplying the old one?
      - How do I reset the encryption password on an on-premises vault?
      instructions:
      - text: Replace the encryption password of vault {vaultID} using {uri} in session {session_id}.
        slots:
          vaultID: path.vaultID
          uri: requestBody.uri
          session_id: requestBody.session_id
      - text: Reset the forgotten password of encrypted on-prem vault {vaultID} with {uri}, session {session_id}.
        slots:
          vaultID: path.vaultID
          uri: requestBody.uri
          session_id: requestBody.session_id
      method: generated
      generated: '2026-09-26'