API Evangelist conversational phrasing for Cohesity REST Restore Tasks API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cohesity REST Restore Tasks API
  version: 1.0.0
extends: openapi/cohesity-restoretasks-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: 30
- target: $.paths['/public/restore/adDomainRootTopology'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the root topology of an AD domain restore
      effect: read
      questions:
      - What does the root topology of the Active Directory domain look like in my AD restore task?
      - Can I browse the top of the AD domain tree for a specific restore task before recovering objects?
      instructions:
      - text: Show the AD domain root topology for restore task {restoreTaskId}.
        slots:
          restoreTaskId: query.restoreTaskId
      - text: Fetch the top-level AD domain tree for restore task {restoreTaskId} so I can pick where to browse.
        slots:
          restoreTaskId: query.restoreTaskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/adObjectAttributes'].post
  update:
    x-apievangelist-phrasing:
      intent: Compare AD object attributes snapshot vs production
      effect: read
      questions:
      - Which attributes of an Active Directory object differ between the backup snapshot and production AD?
      - Can I hide system attributes and identical values when comparing an AD object against its snapshot?
      instructions:
      - text: Compare the AD objects in {guidPairs} for restore task {RestoreTaskId} between snapshot and production.
        slots:
          guidPairs: requestBody.guidPairs
          RestoreTaskId: requestBody.RestoreTaskId
      - text: Do a quick attribute compare of {guidPairs} in restore task {RestoreTaskId}, showing only values that differ.
        slots:
          guidPairs: requestBody.guidPairs
          RestoreTaskId: requestBody.RestoreTaskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/adObjects'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse AD objects in snapshot and production
      effect: read
      questions:
      - Which AD objects under a given base DN are missing from production compared to the snapshot?
      - Can I page through AD objects under an OU and see whether each one is equal, changed or missing in production?
      instructions:
      - text: List AD objects under {searchBaseDn} for restore task {restoreTaskId} with their production match status.
        slots:
          searchBaseDn: query.searchBaseDn
          restoreTaskId: query.restoreTaskId
      - text: Show the next {numObjects} AD objects in restore task {restoreTaskId} starting at offset {recordOffset}.
        slots:
          numObjects: query.numObjects
          restoreTaskId: query.restoreTaskId
          recordOffset: query.recordOffset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/adObjects'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up production AD objects by GUID, SAM or DN
      effect: read
      questions:
      - Can I look up live production AD objects by their object GUIDs or SAM account names?
      - What does production Active Directory currently hold for a list of distinguished names?
      instructions:
      - text: Find production AD objects with SAM account names {samAccountNames}.
        slots:
          samAccountNames: requestBody.samAccountNames
      - text: Look up the production AD objects matching distinguished names {distinguishedNames}.
        slots:
          distinguishedNames: requestBody.distinguishedNames
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/adObjects/searchResults'].get
  update:
    x-apievangelist-phrasing:
      intent: Search backed-up AD objects to recover
      effect: read
      questions:
      - Which backed-up Active Directory users or groups can I recover, searching by name or email?
      - Can I filter recoverable AD objects by object type and protection job?
      instructions:
      - text: Search recoverable AD objects named {name}.
        slots:
          name: query.name
      - text: Find the backed-up AD user with email {email} in domain {domain} to recover.
        slots:
          email: query.email
          domain: query.domain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/adObjects/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check restore status of recovered AD objects
      effect: read
      questions:
      - Did the AD objects I restored from the snapshot make it back into production?
      - What is the per-object restore status for an Active Directory restore task?
      instructions:
      - text: Show the AD object restore status for restore task {restoreTaskId}.
        slots:
          restoreTaskId: query.restoreTaskId
      - text: Check which AD objects in restore task {restoreTaskId} were restored to production successfully.
        slots:
          restoreTaskId: query.restoreTaskId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/applicationsClone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone an application such as a SQL database
      effect: write
      questions:
      - Can I clone a backed-up SQL Server database onto a host for test or dev use?
      - What is needed to spin up a clone of a protected application on another host?
      instructions:
      - text: Create a clone task named {name} for {applicationEnvironment} applications hosted on {hostingProtectionSource}.
        slots:
          name: requestBody.name
          applicationEnvironment: requestBody.applicationEnvironment
          hostingProtectionSource: requestBody.hostingProtectionSource
      - text: Clone the SQL databases {applicationRestoreObjects} onto host {hostingProtectionSource} as task {name}.
        slots:
          applicationRestoreObjects: requestBody.applicationRestoreObjects
          hostingProtectionSource: requestBody.hostingProtectionSource
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/applicationsRecover'].post
  update:
    x-apievangelist-phrasing:
      intent: Recover an application such as a SQL database
      effect: write
      questions:
      - How do I restore a SQL Server database from a Cohesity backup back to its host?
      - Can I recover protected application databases rather than clone them?
      instructions:
      - text: Start an application recovery task named {name} for {applicationEnvironment} on host {hostingProtectionSource}.
        slots:
          name: requestBody.name
          applicationEnvironment: requestBody.applicationEnvironment
          hostingProtectionSource: requestBody.hostingProtectionSource
      - text: Recover the SQL databases {applicationRestoreObjects} back to {hostingProtectionSource} as task {name}.
        slots:
          applicationRestoreObjects: requestBody.applicationRestoreObjects
          hostingProtectionSource: requestBody.hostingProtectionSource
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone VMs or a View from backup
      effect: write
      questions:
      - Can I clone backed-up VMs into a new location without overwriting the originals?
      - What does it take to clone a View from a snapshot under a new view name?
      instructions:
      - text: Create a {type} clone task named {name} for the VMs {objects}.
        slots:
          type: requestBody.type
          name: requestBody.name
          objects: requestBody.objects
      - text: Clone the view as {targetViewName} in a {type} clone task called {name}.
        slots:
          targetViewName: requestBody.targetViewName
          type: requestBody.type
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/clone/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Destroy a clone task and its clones
      effect: destructive
      questions:
      - How do I tear down cloned VMs or views once I'm done testing with them?
      - Can I destroy a clone task by its id to clean up the cloned resources?
      instructions:
      - text: Destroy clone task {id}.
        slots:
          id: path.id
      - text: Clean up the clones created by clone task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/deploy'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy backed-up VMs or a View to cloud
      effect: write
      questions:
      - Can I deploy backed-up VMs into AWS or Azure from Cohesity?
      - Which cloud targets can a restore deploy VMs onto?
      instructions:
      - text: Create a deploy task named {name} to push {objects} to cloud target {target}.
        slots:
          name: requestBody.name
          objects: requestBody.objects
          target: requestBody.target
      - text: Deploy the backed-up VMs as task {name} into the cloud.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/downloadFilesAndFolders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a legacy download task for files and folders
      effect: write
      questions:
      - Can I download specific files and folders out of a backup instead of restoring them in place?
      - What does the older public restore API need to package backed-up files for download?
      instructions:
      - text: Create a download task named {name} for files {filesAndFoldersInfo} using the public restore API.
        slots:
          name: requestBody.name
          filesAndFoldersInfo: requestBody.filesAndFoldersInfo
      - text: Start the legacy files-and-folders download task {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/files'].get
  update:
    x-apievangelist-phrasing:
      intent: Search backed-up files and folders to recover
      effect: read
      questions:
      - Which backed-up files match a filename pattern so I can pick them for recovery?
      - Can I search only folders, or restrict a file search to a time window and protection job?
      instructions:
      - text: Search backups for files matching {search}.
        slots:
          search: query.search
      - text: Find folders only matching {search} backed up by jobs {jobIds}.
        slots:
          search: query.search
          jobIds: query.jobIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/files'].post
  update:
    x-apievangelist-phrasing:
      intent: Recover files and folders to a host
      effect: write
      questions:
      - Can I restore selected files back to the original server or to a different directory?
      - Will a file restore overwrite existing files, and can I preserve their attributes?
      instructions:
      - text: Restore files {filenames} as task {name}.
        slots:
          filenames: requestBody.filenames
          name: requestBody.name
      - text: Recover files {filenames} into {newBaseDirectory} on host {targetSourceId} without overwriting.
        slots:
          filenames: requestBody.filenames
          newBaseDirectory: requestBody.newBaseDirectory
          targetSourceId: requestBody.targetSourceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/files/fstats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fstat details for a file in a snapshot
      effect: read
      questions:
      - What are the size, timestamps and other fstat details of a file inside a backup snapshot?
      - Can I stat one file path in a specific job run before recovering it?
      instructions:
      - text: Get fstat info for {filePath} in job {jobId} run {jobInstanceId} started {jobStartTimeUsecs}, entity {entityId}, job uid object {jobUidObjectId}.
        slots:
          filePath: query.filePath
          jobId: query.jobId
          jobInstanceId: query.jobInstanceId
          jobStartTimeUsecs: query.jobStartTimeUsecs
          entityId: query.entityId
          jobUidObjectId: query.jobUidObjectId
      - text: Stat file {filePath} from entity {entityId} in backup job {jobId}.
        slots:
          filePath: query.filePath
          entityId: query.entityId
          jobId: query.jobId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/files/snapshotsInformation'].get
  update:
    x-apievangelist-phrasing:
      intent: List snapshots that contain a file
      effect: read
      questions:
      - Which backup snapshots contain a particular file or folder?
      - Can I see every version of a file across snapshots so I pick the right one to restore?
      instructions:
      - text: List snapshots of job {jobId} that contain {filename} from source {sourceId} on cluster {clusterId} incarnation {clusterIncarnationId}.
        slots:
          jobId: query.jobId
          filename: query.filename
          sourceId: query.sourceId
          clusterId: query.clusterId
          clusterIncarnationId: query.clusterIncarnationId
      - text: Show which snapshots hold {filename} for source {sourceId}.
        slots:
          filename: query.filename
          sourceId: query.sourceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/objects'].get
  update:
    x-apievangelist-phrasing:
      intent: Search backed-up objects such as VMs to recover
      effect: read
      questions:
      - Which protected VMs or servers have backups I can recover from?
      - Can I filter recoverable backup objects by environment, operating system or application?
      instructions:
      - text: Find backed-up objects matching {search}.
        slots:
          search: query.search
      - text: List recoverable objects in environments {environments} protected by jobs {jobIds}.
        slots:
          environments: query.environments
          jobIds: query.jobIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/office365/onedrive/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: Search backed-up OneDrive files to recover
      effect: read
      questions:
      - Which OneDrive files and folders from Office 365 backups can I recover?
      - Can I search OneDrive backups by document name for a specific mailbox?
      instructions:
      - text: Search OneDrive backups for documents named {documentName}.
        slots:
          documentName: query.documentName
      - text: List recoverable OneDrive files for users {mailboxIds}.
        slots:
          mailboxIds: query.mailboxIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/office365/outlook/emails'].get
  update:
    x-apievangelist-phrasing:
      intent: Search backed-up Outlook emails to recover
      effect: read
      questions:
      - Can I find a deleted Outlook email in the backups by sender or subject?
      - Which backed-up emails with attachments arrived in a given date range?
      instructions:
      - text: Search backed-up Outlook emails from {senderAddress} with subject {emailSubject}.
        slots:
          senderAddress: query.senderAddress
          emailSubject: query.emailSubject
      - text: Find backed-up emails in folder {folderName} for mailboxes {mailboxIds}.
        slots:
          folderName: query.folderName
          mailboxIds: query.mailboxIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/office365/sharepoint/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: Search backed-up SharePoint files to recover
      effect: read
      questions:
      - Which SharePoint site files and folders are in my Office 365 backups?
      - Can I search SharePoint backups for a document by name on specific sites?
      instructions:
      - text: Search SharePoint backups for documents named {documentName}.
        slots:
          documentName: query.documentName
      - text: List recoverable SharePoint files on sites {siteIds}.
        slots:
          siteIds: query.siteIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/pointsForTimeRange'].post
  update:
    x-apievangelist-phrasing:
      intent: List restore points in a time range
      effect: read
      questions:
      - Which restore points exist for a protection job between two dates?
      - Can I see the snapshots available to restore from within a specific time window?
      instructions:
      - text: List restore points for jobs {jobUids} between {startTimeUsecs} and {endTimeUsecs}.
        slots:
          jobUids: requestBody.jobUids
          startTimeUsecs: requestBody.startTimeUsecs
          endTimeUsecs: requestBody.endTimeUsecs
      - text: Show the snapshots for jobs {jobUids} on source {protectionSourceId}.
        slots:
          jobUids: requestBody.jobUids
          protectionSourceId: requestBody.protectionSourceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/recover'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a restore task for Hot-Standby
      effect: write
      questions:
      - Can I turn on auto sync for an existing restore task to keep a Hot-Standby copy current?
      - What extra SQL or AD options can be added to a restore task after it was created?
      instructions:
      - text: Enable auto sync on restore task {restoreTaskId}.
        slots:
          restoreTaskId: requestBody.restoreTaskId
      - text: Update the SQL options of restore task {restoreTaskId} to {sqlOptions}.
        slots:
          restoreTaskId: requestBody.restoreTaskId
          sqlOptions: requestBody.sqlOptions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/recover'].post
  update:
    x-apievangelist-phrasing:
      intent: Recover VMs or instantly mount volumes
      effect: write
      questions:
      - How do I recover VMs from backup to their original location or a new one?
      - Can I instantly mount volumes from a snapshot instead of doing a full restore?
      instructions:
      - text: Create a {type} recover task named {name} for VMs {objects}.
        slots:
          type: requestBody.type
          name: requestBody.name
          objects: requestBody.objects
      - text: Start recover task {name} of type {type} to mount volumes with {mountParameters}.
        slots:
          name: requestBody.name
          type: requestBody.type
          mountParameters: requestBody.mountParameters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List restore tasks
      effect: read
      questions:
      - Which restore tasks are running or finished on my cluster?
      - Can I filter restore tasks by type, environment or a start and end time?
      instructions:
      - text: List restore tasks of types {taskTypes}.
        slots:
          taskTypes: query.taskTypes
      - text: Show restore tasks started between {startTimeUsecs} and {endTimeUsecs}.
        slots:
          startTimeUsecs: query.startTimeUsecs
          endTimeUsecs: query.endTimeUsecs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/tasks/cancel/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running recover or clone task
      effect: destructive
      questions:
      - Can I stop a recover or clone task that is still in progress?
      - What happens if I cancel a restore task midway?
      instructions:
      - text: Cancel restore task {id}.
        slots:
          id: path.id
      - text: Stop the in-progress clone task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/tasks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one restore task
      effect: read
      questions:
      - What is the current status and progress of a specific restore task?
      - Can I pull the full details of one restore task by its id?
      instructions:
      - text: Show details for restore task {id}.
        slots:
          id: path.id
      - text: Check the progress of restore task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/virtualDiskInformation'].get
  update:
    x-apievangelist-phrasing:
      intent: Get virtual disk details from a backup run
      effect: read
      questions:
      - What virtual disks were captured for a VM in a particular backup run?
      - Can I read virtual disk information from an archived snapshot in a vault?
      instructions:
      - text: Get virtual disk info for source {sourceId} in job {jobId} run {jobRunId} started {startTimeUsecs} on cluster {clusterId} incarnation {clusterIncarnationId}.
        slots:
          sourceId: query.sourceId
          jobId: query.jobId
          jobRunId: query.jobRunId
          startTimeUsecs: query.startTimeUsecs
          clusterId: query.clusterId
          clusterIncarnationId: query.clusterIncarnationId
      - text: Show the virtual disks backed up for VM {sourceId} in run {jobRunId}.
        slots:
          sourceId: query.sourceId
          jobRunId: query.jobRunId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/vms/directoryList'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse a directory inside a VM backup
      effect: read
      questions:
      - Can I browse the folders inside a backed-up VM to find files to restore?
      - What files are in a given directory of a VM snapshot, with their stat details?
      instructions:
      - text: List directory {dirPath} in VM {entityId} for job {jobId} run {jobInstanceId} started {jobStartTimeUsecs}, job uid object {jobUidObjectId}.
        slots:
          dirPath: query.dirPath
          entityId: query.entityId
          jobId: query.jobId
          jobInstanceId: query.jobInstanceId
          jobStartTimeUsecs: query.jobStartTimeUsecs
          jobUidObjectId: query.jobUidObjectId
      - text: Browse {dirPath} on volume {volumeName} of a backed-up VM.
        slots:
          dirPath: query.dirPath
          volumeName: query.volumeName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/restore/vms/volumesInformation'].get
  update:
    x-apievangelist-phrasing:
      intent: List logical volumes in a backed-up VM
      effect: read
      questions:
      - Which logical volumes were found in a VM's backup snapshot?
      - Can I see only the supported volumes of a VM before mounting one?
      instructions:
      - text: Get volumes of VM {sourceId}, job {jobId}/{originalJobId}, run {jobRunId} at {startedTimeUsecs}, cluster {clusterId}:{clusterIncarnationId}.
        slots:
          sourceId: query.sourceId
          jobId: query.jobId
          originalJobId: query.originalJobId
          jobRunId: query.jobRunId
          startedTimeUsecs: query.startedTimeUsecs
          clusterId: query.clusterId
          clusterIncarnationId: query.clusterIncarnationId
      - text: Show the supported volumes of VM {sourceId} in backup run {jobRunId}.
        slots:
          sourceId: query.sourceId
          jobRunId: query.jobRunId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/virtualDatacenters/{id}/storageProfiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List storage profiles of a virtual datacenter
      effect: read
      questions:
      - Which storage profiles are available in a vCloud virtual datacenter for restores?
      - What storage policy options does a given virtual datacenter offer?
      instructions:
      - text: List storage profiles for virtual datacenter {id}.
        slots:
          id: path.id
      - text: Show the storage profiles I can restore into on virtual datacenter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'