# 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 Vaults API
  version: 1.0.0
extends: openapi/cohesity-vaults-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: 9
- target: $.paths['/public/vaults'].get
  update:
    x-apievangelist-phrasing:
      intent: List external targets (vaults)
      effect: read
      questions:
      - Which external targets are registered on my Cohesity cluster?
      - Can I find a vault by name?
      - How do I include vaults marked for removal in the list?
      instructions:
      - text: List all external targets.
      - text: Find the vault named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/vaults'].post
  update:
    x-apievangelist-phrasing:
      intent: Register an external target (vault)
      effect: write
      questions:
      - How do I add a cloud archive target to the cluster?
      - Can I create a vault with dedup and encryption enabled?
      instructions:
      - text: Create a vault named {name} of type {type}.
        slots:
          name: requestBody.name
          type: requestBody.type
      - text: Register external target {name} with encryption policy {encryptionPolicy}.
        slots:
          name: requestBody.name
          encryptionPolicy: requestBody.encryptionPolicy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/vaults/archiveMediaInfo'].get
  update:
    x-apievangelist-phrasing:
      intent: Get archive media info for a tape archive
      effect: read
      questions:
      - What tape media does a QStar archive job use?
      - Can I see the media information behind an archive service?
      instructions:
      - text: Get archive media info for QStar job {qstarArchiveJobId} on cluster {clusterId} incarnation {clusterIncarnationId}.
        slots:
          qstarArchiveJobId: query.qstarArchiveJobId
          clusterId: query.clusterId
          clusterIncarnationId: query.clusterIncarnationId
      - text: Show tape media for archive job {qstarArchiveJobId}, cluster {clusterId}, incarnation {clusterIncarnationId}.
        slots:
          qstarArchiveJobId: query.qstarArchiveJobId
          clusterId: query.clusterId
          clusterIncarnationId: query.clusterIncarnationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/vaults/bandwidthSettings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get external target bandwidth limits
      effect: read
      questions:
      - What upload and download bandwidth limits apply to my external targets?
      - Are there bandwidth overrides on archive traffic?
      instructions:
      - text: Show the vault bandwidth settings.
      - text: Get the current upload and download limits for external targets.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/vaults/bandwidthSettings'].put
  update:
    x-apievangelist-phrasing:
      intent: Update external target bandwidth limits
      effect: write
      questions:
      - How do I throttle upload bandwidth to my archive targets?
      - Can I change the download bandwidth limit for vaults?
      instructions:
      - text: Set the vault upload bandwidth limit to {upload}.
        slots:
          upload: requestBody.upload
      - text: Change archive download bandwidth to {download}.
        slots:
          download: requestBody.download
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/vaults/encryptionKey/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a vault's encryption key
      effect: read
      questions:
      - How do I get the encryption key needed to restore archive data to another cluster?
      - Where can I retrieve encryption info for an external target for disaster recovery?
      instructions:
      - text: Get the encryption key for vault {id}.
        slots:
          id: path.id
      - text: Fetch encryption info of external target {id} for a DR restore.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/vaults/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one external target
      effect: read
      questions:
      - What are the settings of a specific vault?
      - Where can I look up an external target by id?
      instructions:
      - text: Show vault {id}.
        slots:
          id: path.id
      - text: Get the details of external target {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/vaults/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an external target
      effect: write
      questions:
      - Can I change the compression or dedup settings of an existing vault?
      - How do I rename an external target?
      instructions:
      - text: Rename vault {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set compression policy {compressionPolicy} on external target {id}.
        slots:
          compressionPolicy: requestBody.compressionPolicy
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/vaults/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an external target
      effect: destructive
      questions:
      - How do I remove an external target from the cluster?
      - Can I force-delete a vault that won't remove cleanly?
      instructions:
      - text: Delete vault {id}.
        slots:
          id: path.id
      - text: Force delete external target {id} with forceDelete={forceDelete}.
        slots:
          id: path.id
          forceDelete: query.forceDelete
      method: generated
      generated: '2026-10-01'