> 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/retention-policies.md).

# Retention policies

Retention policies define how many snapshots to keep and for how long. Snapshots, snapshot schedulers, and replication sessions each use a retention policy.

Use these endpoints to create retention policies before you schedule snapshots or set up replication, or to change how long existing snapshots are kept.

## GET /retention\_policies

> List retention policies

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Retention policies","description":"Retention policies define how many snapshots to keep and for how long. Snapshots, snapshot schedulers, and replication sessions each use a retention policy.\n\nUse these endpoints to create retention policies before you schedule snapshots or set up replication, or to change how long existing snapshots are kept."}],"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."}}},"RetentionPolicies":{"type":"object","properties":{"days":{"type":"integer","description":"Retention duration component, in days."},"hours":{"type":"integer","description":"Retention duration component, in hours."},"id":{"type":"integer","description":"Unique identifier."},"name":{"type":"string","description":"Display name."},"num_snapshots":{"type":"integer","description":"Maximum number of snapshots to retain."},"snapshots_usage_count":{"type":"integer","description":"Number of snapshots currently bound to this retention policy."},"weeks":{"type":"integer","description":"Retention duration component, in weeks."}}},"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":{"/retention_policies":{"get":{"tags":["Retention policies"],"summary":"List retention policies","operationId":"listRetentionPolicies","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/RetentionPolicies"}}}}]}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## POST /retention\_policies

> Create retention policy

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Retention policies","description":"Retention policies define how many snapshots to keep and for how long. Snapshots, snapshot schedulers, and replication sessions each use a retention policy.\n\nUse these endpoints to create retention policies before you schedule snapshots or set up replication, or to change how long existing snapshots are kept."}],"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":{"RetentionPolicies":{"type":"object","properties":{"days":{"type":"integer","description":"Retention duration component, in days."},"hours":{"type":"integer","description":"Retention duration component, in hours."},"id":{"type":"integer","description":"Unique identifier."},"name":{"type":"string","description":"Display name."},"num_snapshots":{"type":"integer","description":"Maximum number of snapshots to retain."},"snapshots_usage_count":{"type":"integer","description":"Number of snapshots currently bound to this retention policy."},"weeks":{"type":"integer","description":"Retention duration component, in weeks."}}},"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":{"/retention_policies":{"post":{"tags":["Retention policies"],"summary":"Create retention policy","operationId":"createRetentionPolicies","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetentionPolicies"}}}},"default":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Create retention policy","properties":{"name":{"type":"string","description":"Display name."},"num_snapshots":{"$ref":"#/components/schemas/RetentionPolicies/properties/num_snapshots"},"weeks":{"$ref":"#/components/schemas/RetentionPolicies/properties/weeks"},"days":{"$ref":"#/components/schemas/RetentionPolicies/properties/days"},"hours":{"$ref":"#/components/schemas/RetentionPolicies/properties/hours"}},"required":["name","num_snapshots","weeks","days","hours"]}}}}}}}}
```

## GET /retention\_policies/{id}

> Get a retention policy

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Retention policies","description":"Retention policies define how many snapshots to keep and for how long. Snapshots, snapshot schedulers, and replication sessions each use a retention policy.\n\nUse these endpoints to create retention policies before you schedule snapshots or set up replication, or to change how long existing snapshots are kept."}],"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":{"RetentionPolicies":{"type":"object","properties":{"days":{"type":"integer","description":"Retention duration component, in days."},"hours":{"type":"integer","description":"Retention duration component, in hours."},"id":{"type":"integer","description":"Unique identifier."},"name":{"type":"string","description":"Display name."},"num_snapshots":{"type":"integer","description":"Maximum number of snapshots to retain."},"snapshots_usage_count":{"type":"integer","description":"Number of snapshots currently bound to this retention policy."},"weeks":{"type":"integer","description":"Retention duration component, in weeks."}}},"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":{"/retention_policies/{id}":{"get":{"tags":["Retention policies"],"summary":"Get a retention policy","operationId":"getRetentionPolicies","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetentionPolicies"}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## DELETE /retention\_policies/{id}

> Delete a retention policy

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Retention policies","description":"Retention policies define how many snapshots to keep and for how long. Snapshots, snapshot schedulers, and replication sessions each use a retention policy.\n\nUse these endpoints to create retention policies before you schedule snapshots or set up replication, or to change how long existing snapshots are kept."}],"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":{"/retention_policies/{id}":{"delete":{"tags":["Retention policies"],"summary":"Delete a retention policy","operationId":"deleteRetentionPolicies","responses":{"204":{"description":"No content"},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## PATCH /retention\_policies/{id}

> Update retention policy

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Retention policies","description":"Retention policies define how many snapshots to keep and for how long. Snapshots, snapshot schedulers, and replication sessions each use a retention policy.\n\nUse these endpoints to create retention policies before you schedule snapshots or set up replication, or to change how long existing snapshots are kept."}],"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":{"RetentionPolicies":{"type":"object","properties":{"days":{"type":"integer","description":"Retention duration component, in days."},"hours":{"type":"integer","description":"Retention duration component, in hours."},"id":{"type":"integer","description":"Unique identifier."},"name":{"type":"string","description":"Display name."},"num_snapshots":{"type":"integer","description":"Maximum number of snapshots to retain."},"snapshots_usage_count":{"type":"integer","description":"Number of snapshots currently bound to this retention policy."},"weeks":{"type":"integer","description":"Retention duration component, in weeks."}}},"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":{"/retention_policies/{id}":{"patch":{"tags":["Retention policies"],"summary":"Update retention policy","operationId":"updateRetentionPolicies","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Update retention policy","properties":{"name":{"type":"string","description":"Display name."},"num_snapshots":{"$ref":"#/components/schemas/RetentionPolicies/properties/num_snapshots"},"weeks":{"$ref":"#/components/schemas/RetentionPolicies/properties/weeks"},"days":{"$ref":"#/components/schemas/RetentionPolicies/properties/days"},"hours":{"$ref":"#/components/schemas/RetentionPolicies/properties/hours"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetentionPolicies"}}}},"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/retention-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.
