# 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 Remote Restore API
  version: 1.0.0
extends: openapi/cohesity-remoterestore-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: 8
- target: $.paths['/public/remoteVaults/encryptionKeys/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload encryption keys for a remote vault
      effect: write
      questions:
      - How do I give the cluster the encryption keys needed to restore from a remote vault?
      - Which key files does CloudRetrieve need before restoring archived data?
      instructions:
      - text: Upload the encryption key files for remote vault {id}.
        slots:
          id: path.id
      - text: Provide the CloudRetrieve encryption keys for vault {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/remoteVaults/restoreTasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List remote vault restore tasks
      effect: read
      questions:
      - Which CloudRetrieve restores from remote vaults are running or done?
      - What's the status of restores pulling archived data from a vault to this cluster?
      instructions:
      - text: List remote vault restore tasks on this cluster.
      - text: Show CloudRetrieve restore tasks and their status.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/remoteVaults/restoreTasks'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore archived data from a remote vault
      effect: write
      questions:
      - After searching a remote vault, how do I restore the indexes and snapshots it found?
      - Can I choose a Glacier retrieval type for a vault restore?
      instructions:
      - text: Create restore task {taskName} from vault {vaultId} for search job {searchJobUid}.
        slots:
          taskName: requestBody.taskName
          vaultId: requestBody.vaultId
          searchJobUid: requestBody.searchJobUid
      - text: Restore {restoreObjects} from vault {vaultId} using search {searchJobUid} as task {taskName}.
        slots:
          restoreObjects: requestBody.restoreObjects
          vaultId: requestBody.vaultId
          searchJobUid: requestBody.searchJobUid
          taskName: requestBody.taskName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/remoteVaults/searchJobResults'].get
  update:
    x-apievangelist-phrasing:
      intent: Get job runs found by a vault search
      effect: read
      questions:
      - Which protection job runs did my remote vault search find?
      - Can I page through the results of a vault search?
      instructions:
      - text: Show results for search job {searchJobId} on cluster {clusterId} incarnation {clusterIncarnationId}.
        slots:
          searchJobId: query.searchJobId
          clusterId: query.clusterId
          clusterIncarnationId: query.clusterIncarnationId
      - text: List job runs found by vault search {searchJobId} (cluster {clusterId}, incarnation {clusterIncarnationId}), {pageCount} per page.
        slots:
          searchJobId: query.searchJobId
          clusterId: query.clusterId
          clusterIncarnationId: query.clusterIncarnationId
          pageCount: query.pageCount
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/remoteVaults/searchJobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List searches of remote vaults
      effect: read
      questions:
      - What remote vault searches have been run on this cluster?
      - Are any vault searches still running?
      instructions:
      - text: List all remote vault search jobs.
      - text: Show every CloudRetrieve vault search.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/remoteVaults/searchJobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Search a remote vault for archived jobs
      effect: write
      questions:
      - How do I find protection jobs archived to a vault so I can restore them elsewhere?
      - Can I narrow a vault search by job name or time range?
      instructions:
      - text: Start a search named {searchJobName} on vault {vaultId}.
        slots:
          searchJobName: requestBody.searchJobName
          vaultId: requestBody.vaultId
      - text: Search vault {vaultId} for jobs matching {jobMatchString}, calling it {searchJobName}.
        slots:
          vaultId: requestBody.vaultId
          jobMatchString: requestBody.jobMatchString
          searchJobName: requestBody.searchJobName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/remoteVaults/searchJobs'].delete
  update:
    x-apievangelist-phrasing:
      intent: Stop a remote vault search
      effect: destructive
      questions:
      - How do I cancel a vault search that's taking too long?
      - Can I stop a running CloudRetrieve search?
      instructions:
      - text: Stop vault search {searchJobUid}.
        slots:
          searchJobUid: requestBody.searchJobUid
      - text: Cancel the running remote vault search {searchJobUid}.
        slots:
          searchJobUid: requestBody.searchJobUid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/remoteVaults/searchJobs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one remote vault search
      effect: read
      questions:
      - What's the status of a specific remote vault search?
      - Which jobs did one vault search match, without run details?
      instructions:
      - text: Show vault search job {id}.
        slots:
          id: path.id
      - text: Get details of remote vault search {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'