# 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 Cluster API
  version: 1.0.0
extends: openapi/cohesity-remotecluster-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: 6
- target: $.paths['/public/remoteClusters'].get
  update:
    x-apievangelist-phrasing:
      intent: List registered remote clusters
      effect: read
      questions:
      - Which remote clusters is this cluster paired with for replication?
      - Can I list only remote clusters registered for remote access?
      instructions:
      - text: List the remote clusters registered on this cluster.
      - text: Show registered remote clusters named {clusterNames}.
        slots:
          clusterNames: query.clusterNames
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/remoteClusters'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a remote cluster for replication
      effect: write
      questions:
      - How do I pair two Cohesity clusters so one can replicate snapshots to the other?
      - Can I just test the remote cluster credentials without saving the registration?
      - Is it possible to cap replication bandwidth to a remote cluster?
      instructions:
      - text: Register remote cluster at {remoteIps} using user {userName}.
        slots:
          remoteIps: requestBody.remoteIps
          userName: requestBody.userName
      - text: Register remote cluster {remoteIps} for replication with bandwidth limit {bandwidthLimit}.
        slots:
          remoteIps: requestBody.remoteIps
          bandwidthLimit: requestBody.bandwidthLimit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/remoteClusters/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a registered remote cluster
      effect: read
      questions:
      - What are the connection settings for one paired remote cluster?
      - Is compression enabled on replication to a specific remote cluster?
      instructions:
      - text: Get remote cluster {id}.
        slots:
          id: path.id
      - text: Show the registration details of remote cluster {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/remoteClusters/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a remote cluster's connection settings
      effect: write
      questions:
      - How do I change the IPs or password used to reach a paired remote cluster?
      - Can I turn on compression for replication to an existing remote cluster?
      instructions:
      - text: Update remote cluster {id} to use IPs {remoteIps}.
        slots:
          id: path.id
          remoteIps: requestBody.remoteIps
      - text: Set the bandwidth limit for remote cluster {id} to {bandwidthLimit}.
        slots:
          id: path.id
          bandwidthLimit: requestBody.bandwidthLimit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/remoteClusters/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unregister a remote cluster
      effect: destructive
      questions:
      - How do I unpair a remote cluster from this one?
      - What happens to replication when I delete a remote cluster registration?
      instructions:
      - text: Delete the registration for remote cluster {id}.
        slots:
          id: path.id
      - text: Unpair remote cluster {id} from this cluster.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/replicationEncryptionKey'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the replication encryption key
      effect: read
      questions:
      - What encryption key does this cluster use for replication traffic?
      - Where do I get the key a remote cluster needs to decrypt replicated data?
      instructions:
      - text: Show this cluster's replication encryption key.
      - text: Get the key used to encrypt replication data.
      method: generated
      generated: '2026-10-01'