> For the complete documentation index, see [llms.txt](https://docs.silk.us/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.silk.us/api-reference/endpoints/replication/peer-volume-groups.md).

# Peer volume groups

Peer volume groups are the volume groups on the replication target that receive replicated data from a source volume group.

Use these endpoints to list peer volume groups or rename one.

## GET /replication/peer\_volume\_groups

> List peer volume groups

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Peer volume groups","description":"Peer volume groups are the volume groups on the replication target that receive replicated data from a source volume group.\n\nUse these endpoints to list peer volume groups or rename one."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"parameters":{"limit":{"name":"__limit","in":"query","schema":{"type":"integer"},"description":"Caps the number of returned entities. Requires a sort parameter when paging."},"offset":{"name":"__offset","in":"query","schema":{"type":"integer"},"description":"Returns results starting from this offset. Requires a sort parameter when paging."},"sort":{"name":"__sort","in":"query","schema":{"type":"string"},"description":"Comma-separated object properties to sort by."},"sort_order":{"name":"__sort_order","in":"query","schema":{"type":"string","enum":["asc","desc"]},"description":"Sort direction."}},"schemas":{"Collection":{"type":"object","properties":{"hits":{"type":"array","items":{},"description":"The matching objects."},"limit":{"type":"integer","description":"Page size."},"offset":{"type":"integer","description":"Offset of the first returned object."},"total":{"type":"integer","description":"Total number of matching objects."}}},"ReplicationPeerVolumeGroups":{"type":"object","properties":{"capacity_state":{"type":"string","description":"Capacity state reported for the peer volume group, e.g. `ok`."},"fullname":{"type":"string","description":"Fully qualified name including the peer system prefix (e.g. `d568_Dedup_vg`)."},"id":{"type":"integer","description":"Unique identifier."},"local_volume_group":{"$ref":"#/components/schemas/Ref","description":"Reference to the local volume group paired with this peer. Shape: `{ \"ref\": \"/volume_groups/{id}\" }`."},"logical_capacity":{"type":"integer","description":"Logical capacity used."},"name":{"type":"string","description":"Short name of the peer volume group."},"remote_volume_group_id":{"type":"integer","description":"ID of the volume group on the peer."},"replication_peer_k2array":{"$ref":"#/components/schemas/Ref","description":"Reference to the peer array. Shape: `{ \"ref\": \"/replication/peer_k2arrays/{id}\" }`."},"replication_session":{"$ref":"#/components/schemas/Ref","description":"Reference to the replication session. Shape: `{ \"ref\": \"/replication/sessions/{id}\" }`."},"replication_session_id":{"type":"integer","description":"ID of the replication session."},"snapshots_logical_capacity":{"type":"integer","description":"Logical capacity attributed to snapshots."},"volumes_logical_capacity":{"type":"integer","description":"Logical capacity attributed to volumes."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/replication/peer_volume_groups":{"get":{"tags":["Peer volume groups"],"summary":"List peer volume groups","operationId":"listReplicationPeerVolumeGroups","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/sort_order"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Collection"},{"type":"object","properties":{"hits":{"type":"array","items":{"$ref":"#/components/schemas/ReplicationPeerVolumeGroups"}}}}]}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## GET /replication/peer\_volume\_groups/{id}

> Get a peer volume group

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Peer volume groups","description":"Peer volume groups are the volume groups on the replication target that receive replicated data from a source volume group.\n\nUse these endpoints to list peer volume groups or rename one."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"schemas":{"ReplicationPeerVolumeGroups":{"type":"object","properties":{"capacity_state":{"type":"string","description":"Capacity state reported for the peer volume group, e.g. `ok`."},"fullname":{"type":"string","description":"Fully qualified name including the peer system prefix (e.g. `d568_Dedup_vg`)."},"id":{"type":"integer","description":"Unique identifier."},"local_volume_group":{"$ref":"#/components/schemas/Ref","description":"Reference to the local volume group paired with this peer. Shape: `{ \"ref\": \"/volume_groups/{id}\" }`."},"logical_capacity":{"type":"integer","description":"Logical capacity used."},"name":{"type":"string","description":"Short name of the peer volume group."},"remote_volume_group_id":{"type":"integer","description":"ID of the volume group on the peer."},"replication_peer_k2array":{"$ref":"#/components/schemas/Ref","description":"Reference to the peer array. Shape: `{ \"ref\": \"/replication/peer_k2arrays/{id}\" }`."},"replication_session":{"$ref":"#/components/schemas/Ref","description":"Reference to the replication session. Shape: `{ \"ref\": \"/replication/sessions/{id}\" }`."},"replication_session_id":{"type":"integer","description":"ID of the replication session."},"snapshots_logical_capacity":{"type":"integer","description":"Logical capacity attributed to snapshots."},"volumes_logical_capacity":{"type":"integer","description":"Logical capacity attributed to volumes."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/replication/peer_volume_groups/{id}":{"get":{"tags":["Peer volume groups"],"summary":"Get a peer volume group","operationId":"getReplicationPeerVolumeGroups","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplicationPeerVolumeGroups"}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## PATCH /replication/peer\_volume\_groups/{id}

> Rename peer volume group

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Peer volume groups","description":"Peer volume groups are the volume groups on the replication target that receive replicated data from a source volume group.\n\nUse these endpoints to list peer volume groups or rename one."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"schemas":{"ReplicationPeerVolumeGroups":{"type":"object","properties":{"capacity_state":{"type":"string","description":"Capacity state reported for the peer volume group, e.g. `ok`."},"fullname":{"type":"string","description":"Fully qualified name including the peer system prefix (e.g. `d568_Dedup_vg`)."},"id":{"type":"integer","description":"Unique identifier."},"local_volume_group":{"$ref":"#/components/schemas/Ref","description":"Reference to the local volume group paired with this peer. Shape: `{ \"ref\": \"/volume_groups/{id}\" }`."},"logical_capacity":{"type":"integer","description":"Logical capacity used."},"name":{"type":"string","description":"Short name of the peer volume group."},"remote_volume_group_id":{"type":"integer","description":"ID of the volume group on the peer."},"replication_peer_k2array":{"$ref":"#/components/schemas/Ref","description":"Reference to the peer array. Shape: `{ \"ref\": \"/replication/peer_k2arrays/{id}\" }`."},"replication_session":{"$ref":"#/components/schemas/Ref","description":"Reference to the replication session. Shape: `{ \"ref\": \"/replication/sessions/{id}\" }`."},"replication_session_id":{"type":"integer","description":"ID of the replication session."},"snapshots_logical_capacity":{"type":"integer","description":"Logical capacity attributed to snapshots."},"volumes_logical_capacity":{"type":"integer","description":"Logical capacity attributed to volumes."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/replication/peer_volume_groups/{id}":{"patch":{"tags":["Peer volume groups"],"summary":"Rename peer volume group","operationId":"updateReplicationPeerVolumeGroups","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Rename peer volume group","properties":{"name":{"$ref":"#/components/schemas/ReplicationPeerVolumeGroups/properties/name"}},"required":["name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReplicationPeerVolumeGroups"}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.silk.us/api-reference/endpoints/replication/peer-volume-groups.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
