> 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/volume-group-capacity-policies.md).

# Volume group capacity policies

Volume group capacity policies define what Silk does as a volume group's capacity usage approaches its quota. Each policy sets warning, error, critical, and full thresholds, plus a separate threshold for snapshot capacity.

Use these endpoints to create policies for different workloads and assign them to volume groups, adjust thresholds, or reset a policy to factory defaults.

## GET /vg\_capacity\_policies

> List volume group capacity policies

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Volume group capacity policies","description":"Volume group capacity policies define what Silk does as a volume group's capacity usage approaches its quota. Each policy sets warning, error, critical, and full thresholds, plus a separate threshold for snapshot capacity.\n\nUse these endpoints to create policies for different workloads and assign them to volume groups, adjust thresholds, or reset a policy to factory defaults."}],"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."}}},"VgCapacityPolicies":{"type":"object","properties":{"critical_threshold":{"type":"integer","description":"Percentage at which the policy raises a critical alert."},"error_threshold":{"type":"integer","description":"Percentage at which the policy raises an error."},"full_threshold":{"type":"integer","description":"Percentage at which the volume group is considered full."},"id":{"type":"integer","description":"Unique identifier."},"is_default":{"type":"boolean","description":"`true` when this is the system default capacity policy."},"name":{"type":"string","description":"Display name."},"num_snapshots":{"type":"integer","description":"Snapshot count threshold."},"snapshot_overhead_threshold":{"type":"integer","description":"Percentage threshold for snapshot overhead."},"warning_threshold":{"type":"integer","description":"Percentage at which the policy raises a warning."}}},"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":{"/vg_capacity_policies":{"get":{"tags":["Volume group capacity policies"],"summary":"List volume group capacity policies","operationId":"listVgCapacityPolicies","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/VgCapacityPolicies"}}}}]}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## POST /vg\_capacity\_policies

> Create capacity policy

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Volume group capacity policies","description":"Volume group capacity policies define what Silk does as a volume group's capacity usage approaches its quota. Each policy sets warning, error, critical, and full thresholds, plus a separate threshold for snapshot capacity.\n\nUse these endpoints to create policies for different workloads and assign them to volume groups, adjust thresholds, or reset a policy to factory defaults."}],"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":{"VgCapacityPolicies":{"type":"object","properties":{"critical_threshold":{"type":"integer","description":"Percentage at which the policy raises a critical alert."},"error_threshold":{"type":"integer","description":"Percentage at which the policy raises an error."},"full_threshold":{"type":"integer","description":"Percentage at which the volume group is considered full."},"id":{"type":"integer","description":"Unique identifier."},"is_default":{"type":"boolean","description":"`true` when this is the system default capacity policy."},"name":{"type":"string","description":"Display name."},"num_snapshots":{"type":"integer","description":"Snapshot count threshold."},"snapshot_overhead_threshold":{"type":"integer","description":"Percentage threshold for snapshot overhead."},"warning_threshold":{"type":"integer","description":"Percentage at which the policy raises a warning."}}},"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":{"/vg_capacity_policies":{"post":{"tags":["Volume group capacity policies"],"summary":"Create capacity policy","operationId":"createVgCapacityPolicies","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VgCapacityPolicies"}}}},"default":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Create capacity policy","properties":{"name":{"type":"string","description":"Display name."},"warning_threshold":{"$ref":"#/components/schemas/VgCapacityPolicies/properties/warning_threshold"},"error_threshold":{"$ref":"#/components/schemas/VgCapacityPolicies/properties/error_threshold"},"critical_threshold":{"$ref":"#/components/schemas/VgCapacityPolicies/properties/critical_threshold"},"full_threshold":{"$ref":"#/components/schemas/VgCapacityPolicies/properties/full_threshold"},"snapshot_overhead_threshold":{"$ref":"#/components/schemas/VgCapacityPolicies/properties/snapshot_overhead_threshold"}},"required":["name","warning_threshold","error_threshold","critical_threshold","full_threshold","snapshot_overhead_threshold"]}}}}}}}}
```

## GET /vg\_capacity\_policies/{id}

> Get a volume group capacity policy

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Volume group capacity policies","description":"Volume group capacity policies define what Silk does as a volume group's capacity usage approaches its quota. Each policy sets warning, error, critical, and full thresholds, plus a separate threshold for snapshot capacity.\n\nUse these endpoints to create policies for different workloads and assign them to volume groups, adjust thresholds, or reset a policy to factory defaults."}],"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":{"VgCapacityPolicies":{"type":"object","properties":{"critical_threshold":{"type":"integer","description":"Percentage at which the policy raises a critical alert."},"error_threshold":{"type":"integer","description":"Percentage at which the policy raises an error."},"full_threshold":{"type":"integer","description":"Percentage at which the volume group is considered full."},"id":{"type":"integer","description":"Unique identifier."},"is_default":{"type":"boolean","description":"`true` when this is the system default capacity policy."},"name":{"type":"string","description":"Display name."},"num_snapshots":{"type":"integer","description":"Snapshot count threshold."},"snapshot_overhead_threshold":{"type":"integer","description":"Percentage threshold for snapshot overhead."},"warning_threshold":{"type":"integer","description":"Percentage at which the policy raises a warning."}}},"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":{"/vg_capacity_policies/{id}":{"get":{"tags":["Volume group capacity policies"],"summary":"Get a volume group capacity policy","operationId":"getVgCapacityPolicies","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VgCapacityPolicies"}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## DELETE /vg\_capacity\_policies/{id}

> Delete a volume group capacity policy

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Volume group capacity policies","description":"Volume group capacity policies define what Silk does as a volume group's capacity usage approaches its quota. Each policy sets warning, error, critical, and full thresholds, plus a separate threshold for snapshot capacity.\n\nUse these endpoints to create policies for different workloads and assign them to volume groups, adjust thresholds, or reset a policy to factory defaults."}],"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":{"/vg_capacity_policies/{id}":{"delete":{"tags":["Volume group capacity policies"],"summary":"Delete a volume group capacity policy","operationId":"deleteVgCapacityPolicies","responses":{"204":{"description":"No content"},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## PATCH /vg\_capacity\_policies/{id}

> Update a volume group capacity policy

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Volume group capacity policies","description":"Volume group capacity policies define what Silk does as a volume group's capacity usage approaches its quota. Each policy sets warning, error, critical, and full thresholds, plus a separate threshold for snapshot capacity.\n\nUse these endpoints to create policies for different workloads and assign them to volume groups, adjust thresholds, or reset a policy to factory defaults."}],"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":{"VgCapacityPolicies":{"type":"object","properties":{"critical_threshold":{"type":"integer","description":"Percentage at which the policy raises a critical alert."},"error_threshold":{"type":"integer","description":"Percentage at which the policy raises an error."},"full_threshold":{"type":"integer","description":"Percentage at which the volume group is considered full."},"id":{"type":"integer","description":"Unique identifier."},"is_default":{"type":"boolean","description":"`true` when this is the system default capacity policy."},"name":{"type":"string","description":"Display name."},"num_snapshots":{"type":"integer","description":"Snapshot count threshold."},"snapshot_overhead_threshold":{"type":"integer","description":"Percentage threshold for snapshot overhead."},"warning_threshold":{"type":"integer","description":"Percentage at which the policy raises a warning."}}},"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":{"/vg_capacity_policies/{id}":{"patch":{"tags":["Volume group capacity policies"],"summary":"Update a volume group capacity policy","operationId":"updateVgCapacityPolicies","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Update thresholds","properties":{"warning_threshold":{"$ref":"#/components/schemas/VgCapacityPolicies/properties/warning_threshold"},"error_threshold":{"$ref":"#/components/schemas/VgCapacityPolicies/properties/error_threshold"},"critical_threshold":{"$ref":"#/components/schemas/VgCapacityPolicies/properties/critical_threshold"},"full_threshold":{"$ref":"#/components/schemas/VgCapacityPolicies/properties/full_threshold"},"num_snapshots":{"$ref":"#/components/schemas/VgCapacityPolicies/properties/num_snapshots"},"snapshot_overhead_threshold":{"$ref":"#/components/schemas/VgCapacityPolicies/properties/snapshot_overhead_threshold"}}},{"type":"object","title":"Reset to factory defaults","properties":{"reset_to_factory_defaults":{"type":"boolean"}}}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VgCapacityPolicies"}}}},"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/volume-group-capacity-policies.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.
