> 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/volumes-and-data-protection/volumes.md).

# Volumes

Volumes are block storage resources that applications and databases read from and write to. Each volume belongs to one volume group, and a host can access it only after you map it with the Mappings endpoints. Silk distributes each volume's workload across the system's c.nodes automatically.

Use these endpoints to provision storage, resize or rename a volume, move it to another volume group, create thin or full clones, or manage its tags.

## GET /volumes

> List volumes

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Volumes","description":"Volumes are block storage resources that applications and databases read from and write to. Each volume belongs to one volume group, and a host can access it only after you map it with the Mappings endpoints. Silk distributes each volume's workload across the system's c.nodes automatically.\n\nUse these endpoints to provision storage, resize or rename a volume, move it to another volume group, create thin or full clones, or manage its tags."}],"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."},"tag_key":{"name":"tag_key","in":"query","schema":{"type":"string"},"description":"Return only objects with this tag key."},"tag_value":{"name":"tag_value","in":"query","schema":{"type":"string"},"description":"Return only objects with this tag value."}},"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."}}},"Volumes":{"type":"object","properties":{"avg_compressed_ratio":{"type":"number","description":"Average compression ratio."},"avg_compressed_ratio_timestamp":{"type":"integer","description":"Timestamp of the last compression-ratio computation."},"clones_count":{"type":"integer"},"creation_time":{"type":"integer","description":"Unix timestamp the volume was created."},"current_replication_stats":{"$ref":"#/components/schemas/Ref","description":"Live replication stats endpoint, if applicable."},"current_stats":{"$ref":"#/components/schemas/Ref","description":"Live performance stats endpoint for this volume."},"description":{"type":"string","nullable":true,"description":"Free-form description."},"id":{"type":"integer","description":"Unique identifier."},"is_dedup":{"type":"boolean","description":"Whether deduplication is enabled."},"is_new":{"type":"boolean","description":"`true` for newly created volumes that have not yet served data."},"iscsi_tgt_converted_name":{"type":"string","description":"Target name used for iSCSI exposure."},"last_restored_from":{"type":"integer","nullable":true,"description":"ID of the snapshot the volume was last restored from."},"last_restored_time":{"type":"integer","nullable":true,"description":"Unix timestamp of the last restore."},"logical_capacity":{"type":"integer","description":"Logical capacity consumed, in kilobytes."},"marked_for_deletion":{"type":"boolean","description":"`true` when the volume is in the process of being removed."},"name":{"type":"string","description":"Display name."},"node_id":{"type":"integer","description":"Internal node assignment."},"read_only":{"type":"boolean","description":"`true` for read-only exposure."},"replication_peer_volume":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"When the volume is the source of a replication session, this points at the peer volume on the remote SDP. Shape: `{ \"ref\": \"/replication/peer_volumes/{id}\" }`."},"scsi_sn":{"type":"string","description":"SCSI serial number assigned by the SDP."},"scsi_suffix":{"type":"integer","description":"Numeric suffix component of the serial."},"size":{"type":"integer","description":"Provisioned size, in kilobytes."},"snapshots_logical_capacity":{"type":"integer","description":"Logical capacity consumed by snapshots associated with the volume."},"source_snap":{"$ref":"#/components/schemas/Ref"},"source_snap_id":{"type":"integer"},"historic_source_snap_id":{"type":"integer"},"full_clone":{"type":"object","properties":{"state_text":{"type":"string"},"progress":{"type":"integer"},"stop_reason_text":{"type":"string"}}},"stream_avg_compressed_size_in_bytes":{"type":"number","description":"Average compressed stream size, in bytes."},"vmware_support":{"type":"boolean","description":"`true` enables VMFS-friendly behavior. Set this when the volume will host a VMware datastore."},"volume_group":{"$ref":"#/components/schemas/Ref","description":"Reference to the parent volume group. Shape: `{ \"ref\": \"/volume_groups/{id}\" }`. Required at creation time; changeable via PATCH to move the volume to another group."}}},"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":{"/volumes":{"get":{"tags":["Volumes"],"summary":"List volumes","operationId":"listVolumes","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/sort_order"},{"$ref":"#/components/parameters/tag_key"},{"$ref":"#/components/parameters/tag_value"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Collection"},{"type":"object","properties":{"hits":{"type":"array","items":{"$ref":"#/components/schemas/Volumes"}}}}]}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## POST /volumes

> Create a volume

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Volumes","description":"Volumes are block storage resources that applications and databases read from and write to. Each volume belongs to one volume group, and a host can access it only after you map it with the Mappings endpoints. Silk distributes each volume's workload across the system's c.nodes automatically.\n\nUse these endpoints to provision storage, resize or rename a volume, move it to another volume group, create thin or full clones, or manage its tags."}],"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":{"Volumes":{"type":"object","properties":{"avg_compressed_ratio":{"type":"number","description":"Average compression ratio."},"avg_compressed_ratio_timestamp":{"type":"integer","description":"Timestamp of the last compression-ratio computation."},"clones_count":{"type":"integer"},"creation_time":{"type":"integer","description":"Unix timestamp the volume was created."},"current_replication_stats":{"$ref":"#/components/schemas/Ref","description":"Live replication stats endpoint, if applicable."},"current_stats":{"$ref":"#/components/schemas/Ref","description":"Live performance stats endpoint for this volume."},"description":{"type":"string","nullable":true,"description":"Free-form description."},"id":{"type":"integer","description":"Unique identifier."},"is_dedup":{"type":"boolean","description":"Whether deduplication is enabled."},"is_new":{"type":"boolean","description":"`true` for newly created volumes that have not yet served data."},"iscsi_tgt_converted_name":{"type":"string","description":"Target name used for iSCSI exposure."},"last_restored_from":{"type":"integer","nullable":true,"description":"ID of the snapshot the volume was last restored from."},"last_restored_time":{"type":"integer","nullable":true,"description":"Unix timestamp of the last restore."},"logical_capacity":{"type":"integer","description":"Logical capacity consumed, in kilobytes."},"marked_for_deletion":{"type":"boolean","description":"`true` when the volume is in the process of being removed."},"name":{"type":"string","description":"Display name."},"node_id":{"type":"integer","description":"Internal node assignment."},"read_only":{"type":"boolean","description":"`true` for read-only exposure."},"replication_peer_volume":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"When the volume is the source of a replication session, this points at the peer volume on the remote SDP. Shape: `{ \"ref\": \"/replication/peer_volumes/{id}\" }`."},"scsi_sn":{"type":"string","description":"SCSI serial number assigned by the SDP."},"scsi_suffix":{"type":"integer","description":"Numeric suffix component of the serial."},"size":{"type":"integer","description":"Provisioned size, in kilobytes."},"snapshots_logical_capacity":{"type":"integer","description":"Logical capacity consumed by snapshots associated with the volume."},"source_snap":{"$ref":"#/components/schemas/Ref"},"source_snap_id":{"type":"integer"},"historic_source_snap_id":{"type":"integer"},"full_clone":{"type":"object","properties":{"state_text":{"type":"string"},"progress":{"type":"integer"},"stop_reason_text":{"type":"string"}}},"stream_avg_compressed_size_in_bytes":{"type":"number","description":"Average compressed stream size, in bytes."},"vmware_support":{"type":"boolean","description":"`true` enables VMFS-friendly behavior. Set this when the volume will host a VMware datastore."},"volume_group":{"$ref":"#/components/schemas/Ref","description":"Reference to the parent volume group. Shape: `{ \"ref\": \"/volume_groups/{id}\" }`. Required at creation time; changeable via PATCH to move the volume to another group."}}},"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":{"/volumes":{"post":{"tags":["Volumes"],"summary":"Create a volume","operationId":"createVolumes","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Volumes"}}}},"default":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Create volume","properties":{"name":{"type":"string","description":"Display name."},"size":{"$ref":"#/components/schemas/Volumes/properties/size"},"volume_group":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"description":"Reference to the parent volume group. Shape: `{ \"ref\": \"/volume_groups/{id}\" }`. Required at creation time; changeable via PATCH to move the volume to another group."},"vmware_support":{"$ref":"#/components/schemas/Volumes/properties/vmware_support"},"description":{"$ref":"#/components/schemas/Volumes/properties/description"},"read_only":{"$ref":"#/components/schemas/Volumes/properties/read_only"},"source_volume":{"$ref":"#/components/schemas/Ref"},"source_snapshot":{"$ref":"#/components/schemas/Ref"}},"required":["name","size","volume_group"]},{"type":"object","title":"Create thin clone","properties":{"is_thin_clone":{"type":"boolean"},"name":{"type":"string","description":"Display name."},"source_volume":{"$ref":"#/components/schemas/Ref"},"volume_group":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"description":"Reference to the parent volume group. Shape: `{ \"ref\": \"/volume_groups/{id}\" }`. Required at creation time; changeable via PATCH to move the volume to another group."},"source_snapshot":{"$ref":"#/components/schemas/Ref"}},"required":["is_thin_clone","name","source_volume"]},{"type":"object","title":"Create full clone","properties":{"is_full_clone":{"type":"boolean"},"name":{"type":"string","description":"Display name."},"source_volume":{"$ref":"#/components/schemas/Ref"},"volume_group":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"description":"Reference to the parent volume group. Shape: `{ \"ref\": \"/volume_groups/{id}\" }`. Required at creation time; changeable via PATCH to move the volume to another group."},"source_snapshot":{"$ref":"#/components/schemas/Ref"}},"required":["is_full_clone","name","source_volume"]}]}}}}}}}}
```

## GET /volumes/{id}

> Get a volume

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Volumes","description":"Volumes are block storage resources that applications and databases read from and write to. Each volume belongs to one volume group, and a host can access it only after you map it with the Mappings endpoints. Silk distributes each volume's workload across the system's c.nodes automatically.\n\nUse these endpoints to provision storage, resize or rename a volume, move it to another volume group, create thin or full clones, or manage its tags."}],"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":{"Volumes":{"type":"object","properties":{"avg_compressed_ratio":{"type":"number","description":"Average compression ratio."},"avg_compressed_ratio_timestamp":{"type":"integer","description":"Timestamp of the last compression-ratio computation."},"clones_count":{"type":"integer"},"creation_time":{"type":"integer","description":"Unix timestamp the volume was created."},"current_replication_stats":{"$ref":"#/components/schemas/Ref","description":"Live replication stats endpoint, if applicable."},"current_stats":{"$ref":"#/components/schemas/Ref","description":"Live performance stats endpoint for this volume."},"description":{"type":"string","nullable":true,"description":"Free-form description."},"id":{"type":"integer","description":"Unique identifier."},"is_dedup":{"type":"boolean","description":"Whether deduplication is enabled."},"is_new":{"type":"boolean","description":"`true` for newly created volumes that have not yet served data."},"iscsi_tgt_converted_name":{"type":"string","description":"Target name used for iSCSI exposure."},"last_restored_from":{"type":"integer","nullable":true,"description":"ID of the snapshot the volume was last restored from."},"last_restored_time":{"type":"integer","nullable":true,"description":"Unix timestamp of the last restore."},"logical_capacity":{"type":"integer","description":"Logical capacity consumed, in kilobytes."},"marked_for_deletion":{"type":"boolean","description":"`true` when the volume is in the process of being removed."},"name":{"type":"string","description":"Display name."},"node_id":{"type":"integer","description":"Internal node assignment."},"read_only":{"type":"boolean","description":"`true` for read-only exposure."},"replication_peer_volume":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"When the volume is the source of a replication session, this points at the peer volume on the remote SDP. Shape: `{ \"ref\": \"/replication/peer_volumes/{id}\" }`."},"scsi_sn":{"type":"string","description":"SCSI serial number assigned by the SDP."},"scsi_suffix":{"type":"integer","description":"Numeric suffix component of the serial."},"size":{"type":"integer","description":"Provisioned size, in kilobytes."},"snapshots_logical_capacity":{"type":"integer","description":"Logical capacity consumed by snapshots associated with the volume."},"source_snap":{"$ref":"#/components/schemas/Ref"},"source_snap_id":{"type":"integer"},"historic_source_snap_id":{"type":"integer"},"full_clone":{"type":"object","properties":{"state_text":{"type":"string"},"progress":{"type":"integer"},"stop_reason_text":{"type":"string"}}},"stream_avg_compressed_size_in_bytes":{"type":"number","description":"Average compressed stream size, in bytes."},"vmware_support":{"type":"boolean","description":"`true` enables VMFS-friendly behavior. Set this when the volume will host a VMware datastore."},"volume_group":{"$ref":"#/components/schemas/Ref","description":"Reference to the parent volume group. Shape: `{ \"ref\": \"/volume_groups/{id}\" }`. Required at creation time; changeable via PATCH to move the volume to another group."}}},"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":{"/volumes/{id}":{"get":{"tags":["Volumes"],"summary":"Get a volume","operationId":"getVolumes","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Volumes"}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## DELETE /volumes/{id}

> Delete a volume

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Volumes","description":"Volumes are block storage resources that applications and databases read from and write to. Each volume belongs to one volume group, and a host can access it only after you map it with the Mappings endpoints. Silk distributes each volume's workload across the system's c.nodes automatically.\n\nUse these endpoints to provision storage, resize or rename a volume, move it to another volume group, create thin or full clones, or manage its tags."}],"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`)."}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}}},"paths":{"/volumes/{id}":{"delete":{"tags":["Volumes"],"summary":"Delete a volume","operationId":"deleteVolumes","responses":{"204":{"description":"No content"},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## Update a volume

> Set \`volume\_group\` to move a volume to another volume group.\
> \
> \> \*\*Warning:\*\* Moving a volume to another volume group deletes its existing snapshots. Review any snapshot or data-protection dependencies before moving a volume.

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Volumes","description":"Volumes are block storage resources that applications and databases read from and write to. Each volume belongs to one volume group, and a host can access it only after you map it with the Mappings endpoints. Silk distributes each volume's workload across the system's c.nodes automatically.\n\nUse these endpoints to provision storage, resize or rename a volume, move it to another volume group, create thin or full clones, or manage its tags."}],"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":{"Volumes":{"type":"object","properties":{"avg_compressed_ratio":{"type":"number","description":"Average compression ratio."},"avg_compressed_ratio_timestamp":{"type":"integer","description":"Timestamp of the last compression-ratio computation."},"clones_count":{"type":"integer"},"creation_time":{"type":"integer","description":"Unix timestamp the volume was created."},"current_replication_stats":{"$ref":"#/components/schemas/Ref","description":"Live replication stats endpoint, if applicable."},"current_stats":{"$ref":"#/components/schemas/Ref","description":"Live performance stats endpoint for this volume."},"description":{"type":"string","nullable":true,"description":"Free-form description."},"id":{"type":"integer","description":"Unique identifier."},"is_dedup":{"type":"boolean","description":"Whether deduplication is enabled."},"is_new":{"type":"boolean","description":"`true` for newly created volumes that have not yet served data."},"iscsi_tgt_converted_name":{"type":"string","description":"Target name used for iSCSI exposure."},"last_restored_from":{"type":"integer","nullable":true,"description":"ID of the snapshot the volume was last restored from."},"last_restored_time":{"type":"integer","nullable":true,"description":"Unix timestamp of the last restore."},"logical_capacity":{"type":"integer","description":"Logical capacity consumed, in kilobytes."},"marked_for_deletion":{"type":"boolean","description":"`true` when the volume is in the process of being removed."},"name":{"type":"string","description":"Display name."},"node_id":{"type":"integer","description":"Internal node assignment."},"read_only":{"type":"boolean","description":"`true` for read-only exposure."},"replication_peer_volume":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"When the volume is the source of a replication session, this points at the peer volume on the remote SDP. Shape: `{ \"ref\": \"/replication/peer_volumes/{id}\" }`."},"scsi_sn":{"type":"string","description":"SCSI serial number assigned by the SDP."},"scsi_suffix":{"type":"integer","description":"Numeric suffix component of the serial."},"size":{"type":"integer","description":"Provisioned size, in kilobytes."},"snapshots_logical_capacity":{"type":"integer","description":"Logical capacity consumed by snapshots associated with the volume."},"source_snap":{"$ref":"#/components/schemas/Ref"},"source_snap_id":{"type":"integer"},"historic_source_snap_id":{"type":"integer"},"full_clone":{"type":"object","properties":{"state_text":{"type":"string"},"progress":{"type":"integer"},"stop_reason_text":{"type":"string"}}},"stream_avg_compressed_size_in_bytes":{"type":"number","description":"Average compressed stream size, in bytes."},"vmware_support":{"type":"boolean","description":"`true` enables VMFS-friendly behavior. Set this when the volume will host a VMware datastore."},"volume_group":{"$ref":"#/components/schemas/Ref","description":"Reference to the parent volume group. Shape: `{ \"ref\": \"/volume_groups/{id}\" }`. Required at creation time; changeable via PATCH to move the volume to another group."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]},"UserTag":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"is_inheritable":{"type":"boolean"},"is_automatic":{"type":"boolean"}}},"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":{"/volumes/{id}":{"patch":{"tags":["Volumes"],"summary":"Update a volume","operationId":"updateVolumes","description":"Set `volume_group` to move a volume to another volume group.\n\n> **Warning:** Moving a volume to another volume group deletes its existing snapshots. Review any snapshot or data-protection dependencies before moving a volume.","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Update volume","properties":{"name":{"type":"string","description":"Display name."},"size":{"$ref":"#/components/schemas/Volumes/properties/size"},"description":{"$ref":"#/components/schemas/Volumes/properties/description"},"volume_group":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"description":"Reference to the parent volume group. Shape: `{ \"ref\": \"/volume_groups/{id}\" }`. Required at creation time; changeable via PATCH to move the volume to another group."}}},{"type":"object","title":"Reset compression ratio timestamp","properties":{"avg_compressed_ratio_timestamp":{"$ref":"#/components/schemas/Volumes/properties/avg_compressed_ratio_timestamp"}}},{"type":"object","title":"Control full clone copy","properties":{"name":{"type":"string","description":"Display name."},"full_clone_operation":{"type":"string","description":"One of `pause`, `cancel`, or `resume`.","enum":["pause","cancel","resume"]}},"required":["name","full_clone_operation"]},{"type":"object","title":"Maintain tags","properties":{"action":{"type":"string","enum":["set_object_tags"],"description":"Tag operation to perform."},"chkargs_validation_only":{"type":"boolean","description":"If `true`, validates the request and reports whether it would succeed without applying it."},"user_tags":{"type":"array","items":{"$ref":"#/components/schemas/UserTag"},"description":"Tags to set on the object."}}}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Volumes"}}}},"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/volumes-and-data-protection/volumes.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.
