> 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/system-configuration/system-capacity-policy.md).

# System capacity policy

The system-wide capacity policy, which sets the capacity thresholds at which the system reports warning, error, critical, and full states.

Use this endpoint to review the thresholds, adjust them to match your capacity targets, or reset them to factory defaults.

## GET /system/capacity\_policy

> Get system capacity policy

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"System capacity policy","description":"The system-wide capacity policy, which sets the capacity thresholds at which the system reports warning, error, critical, and full states.\n\nUse this endpoint to review the thresholds, adjust them to match your capacity targets, or reset them 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."}}},"SystemCapacityPolicy":{"type":"object","properties":{"critical_threshold":{"type":"integer","description":"Percentage at which a critical alert is raised."},"error_threshold":{"type":"integer","description":"Percentage at which an error is raised."},"full_threshold":{"type":"integer","description":"Percentage that represents capacity-full."},"id":{"type":"integer","description":"Unique identifier."},"num_snapshots":{"type":"integer","description":"Number of snapshots retained per source."},"warning_threshold":{"type":"integer","description":"Percentage at which a warning is raised."}}},"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":{"/system/capacity_policy":{"get":{"tags":["System capacity policy"],"summary":"Get system capacity policy","operationId":"listSystemCapacityPolicy","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/SystemCapacityPolicy"}}}}]}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## GET /system/capacity\_policy/{id}

> Get system capacity policy by ID

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"System capacity policy","description":"The system-wide capacity policy, which sets the capacity thresholds at which the system reports warning, error, critical, and full states.\n\nUse this endpoint to review the thresholds, adjust them to match your capacity targets, or reset them 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":{"SystemCapacityPolicy":{"type":"object","properties":{"critical_threshold":{"type":"integer","description":"Percentage at which a critical alert is raised."},"error_threshold":{"type":"integer","description":"Percentage at which an error is raised."},"full_threshold":{"type":"integer","description":"Percentage that represents capacity-full."},"id":{"type":"integer","description":"Unique identifier."},"num_snapshots":{"type":"integer","description":"Number of snapshots retained per source."},"warning_threshold":{"type":"integer","description":"Percentage at which a warning is raised."}}},"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":{"/system/capacity_policy/{id}":{"get":{"tags":["System capacity policy"],"summary":"Get system capacity policy by ID","operationId":"getSystemCapacityPolicy","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemCapacityPolicy"}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## PATCH /system/capacity\_policy/{id}

> Update system capacity policy

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"System capacity policy","description":"The system-wide capacity policy, which sets the capacity thresholds at which the system reports warning, error, critical, and full states.\n\nUse this endpoint to review the thresholds, adjust them to match your capacity targets, or reset them 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":{"SystemCapacityPolicy":{"type":"object","properties":{"critical_threshold":{"type":"integer","description":"Percentage at which a critical alert is raised."},"error_threshold":{"type":"integer","description":"Percentage at which an error is raised."},"full_threshold":{"type":"integer","description":"Percentage that represents capacity-full."},"id":{"type":"integer","description":"Unique identifier."},"num_snapshots":{"type":"integer","description":"Number of snapshots retained per source."},"warning_threshold":{"type":"integer","description":"Percentage at which a warning is raised."}}},"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":{"/system/capacity_policy/{id}":{"patch":{"tags":["System capacity policy"],"summary":"Update system capacity policy","operationId":"updateSystemCapacityPolicy","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Update thresholds","properties":{"warning_threshold":{"$ref":"#/components/schemas/SystemCapacityPolicy/properties/warning_threshold"},"error_threshold":{"$ref":"#/components/schemas/SystemCapacityPolicy/properties/error_threshold"},"critical_threshold":{"$ref":"#/components/schemas/SystemCapacityPolicy/properties/critical_threshold"},"full_threshold":{"$ref":"#/components/schemas/SystemCapacityPolicy/properties/full_threshold"},"num_snapshots":{"$ref":"#/components/schemas/SystemCapacityPolicy/properties/num_snapshots"}}},{"type":"object","title":"Reset to factory defaults","properties":{"reset_to_factory_defaults":{"type":"boolean","description":"Pass `true` to restore default thresholds and snapshot retention."}}}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemCapacityPolicy"}}}},"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/system-configuration/system-capacity-policy.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.
