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

# Snapshots

Snapshots are instant, point-in-time copies of a volume group. They don't initially consume additional capacity; Silk preserves only the data needed to maintain each point in time as the source changes.

Use these endpoints to create a recovery point before a risky change, preserve data for development or testing, create writable copies, or manage snapshot retention and tags.

## GET /snapshots

> List snapshots

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Snapshots","description":"Snapshots are instant, point-in-time copies of a volume group. They don't initially consume additional capacity; Silk preserves only the data needed to maintain each point in time as the source changes.\n\nUse these endpoints to create a recovery point before a risky change, preserve data for development or testing, create writable copies, or manage snapshot retention and 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."}}},"Snapshots":{"type":"object","properties":{"creation_time":{"type":"number","description":"Unix timestamp the snapshot was taken."},"data_creation_time":{"type":"integer","nullable":true,"description":"Unix timestamp of the underlying data, distinct from when the metadata record was written."},"description":{"type":"string","nullable":true,"description":"Free-form description."},"generation_number":{"type":"integer","nullable":true,"description":"Per-source counter."},"id":{"type":"integer","description":"Unique identifier."},"is_application_consistent":{"type":"boolean","nullable":true,"description":"`true` when the snapshot was taken with application coordination."},"is_auto_deleteable":{"type":"boolean","description":"`true` if the SDP may auto-delete this record under retention policy."},"is_deleted":{"type":"boolean","description":"`true` once the SDP has marked the record for deletion (it may still be visible briefly)."},"is_exist_on_peer":{"type":"boolean","description":"`true` if the snapshot also exists on a replication peer."},"is_exposable":{"type":"boolean","description":"`true` for views (mappable like a volume), `false` for ordinary snapshots."},"is_external":{"type":"boolean","nullable":true,"description":"`true` if originated from outside the local SDP."},"is_originating_from_peer":{"type":"boolean","nullable":true,"description":"`true` if originated from a replication peer."},"iscsi_tgt_converted_name":{"type":"string","description":"Target name used for iSCSI exposure of an exposable view."},"last_exposed_time":{"type":"integer","nullable":true,"description":"Unix timestamp of the most recent exposure event (views only)."},"name":{"type":"string","description":"Full computed name (`{volume_group}:{short_name}`)."},"replication_session":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the replication session, when applicable."},"retention_policy":{"$ref":"#/components/schemas/Ref","description":"Reference to the retention policy governing this snapshot. Shape: `{ \"ref\": \"/retention_policies/{id}\" }`."},"short_name":{"type":"string","description":"The portion supplied at creation."},"source":{"$ref":"#/components/schemas/Ref","description":"What this snapshot was taken from. - For a snapshot: `{ \"ref\": \"/volume_groups/{id}\" }`. - For a view: `{ \"ref\": \"/snapshots/{id}\" }` (the parent snapshot)."},"triggered_by":{"type":"string","description":"Origin of the create action, e.g. `api`, `scheduler`, `replication`."},"volsnaps_provisioned_capacity":{"type":"integer","description":"Provisioned capacity attributed to the snapshot, in kilobytes."},"volume_group":{"$ref":"#/components/schemas/Ref","description":"Reference to the volume group the snapshot ultimately belongs to. Shape: `{ \"ref\": \"/volume_groups/{id}\" }`."},"wwn":{"type":"string","nullable":true,"description":"WWN assigned to the snapshot/view."}}},"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":{"/snapshots":{"get":{"tags":["Snapshots"],"summary":"List snapshots","operationId":"listSnapshots","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/Snapshots"}}}}]}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## POST /snapshots

> Create snapshot

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Snapshots","description":"Snapshots are instant, point-in-time copies of a volume group. They don't initially consume additional capacity; Silk preserves only the data needed to maintain each point in time as the source changes.\n\nUse these endpoints to create a recovery point before a risky change, preserve data for development or testing, create writable copies, or manage snapshot retention and 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":{"Snapshots":{"type":"object","properties":{"creation_time":{"type":"number","description":"Unix timestamp the snapshot was taken."},"data_creation_time":{"type":"integer","nullable":true,"description":"Unix timestamp of the underlying data, distinct from when the metadata record was written."},"description":{"type":"string","nullable":true,"description":"Free-form description."},"generation_number":{"type":"integer","nullable":true,"description":"Per-source counter."},"id":{"type":"integer","description":"Unique identifier."},"is_application_consistent":{"type":"boolean","nullable":true,"description":"`true` when the snapshot was taken with application coordination."},"is_auto_deleteable":{"type":"boolean","description":"`true` if the SDP may auto-delete this record under retention policy."},"is_deleted":{"type":"boolean","description":"`true` once the SDP has marked the record for deletion (it may still be visible briefly)."},"is_exist_on_peer":{"type":"boolean","description":"`true` if the snapshot also exists on a replication peer."},"is_exposable":{"type":"boolean","description":"`true` for views (mappable like a volume), `false` for ordinary snapshots."},"is_external":{"type":"boolean","nullable":true,"description":"`true` if originated from outside the local SDP."},"is_originating_from_peer":{"type":"boolean","nullable":true,"description":"`true` if originated from a replication peer."},"iscsi_tgt_converted_name":{"type":"string","description":"Target name used for iSCSI exposure of an exposable view."},"last_exposed_time":{"type":"integer","nullable":true,"description":"Unix timestamp of the most recent exposure event (views only)."},"name":{"type":"string","description":"Full computed name (`{volume_group}:{short_name}`)."},"replication_session":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the replication session, when applicable."},"retention_policy":{"$ref":"#/components/schemas/Ref","description":"Reference to the retention policy governing this snapshot. Shape: `{ \"ref\": \"/retention_policies/{id}\" }`."},"short_name":{"type":"string","description":"The portion supplied at creation."},"source":{"$ref":"#/components/schemas/Ref","description":"What this snapshot was taken from. - For a snapshot: `{ \"ref\": \"/volume_groups/{id}\" }`. - For a view: `{ \"ref\": \"/snapshots/{id}\" }` (the parent snapshot)."},"triggered_by":{"type":"string","description":"Origin of the create action, e.g. `api`, `scheduler`, `replication`."},"volsnaps_provisioned_capacity":{"type":"integer","description":"Provisioned capacity attributed to the snapshot, in kilobytes."},"volume_group":{"$ref":"#/components/schemas/Ref","description":"Reference to the volume group the snapshot ultimately belongs to. Shape: `{ \"ref\": \"/volume_groups/{id}\" }`."},"wwn":{"type":"string","nullable":true,"description":"WWN assigned to the snapshot/view."}}},"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":{"/snapshots":{"post":{"tags":["Snapshots"],"summary":"Create snapshot","operationId":"createSnapshots","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Snapshots"}}}},"default":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Create snapshot","properties":{"short_name":{"$ref":"#/components/schemas/Snapshots/properties/short_name"},"source":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"description":"What this snapshot was taken from. - For a snapshot: `{ \"ref\": \"/volume_groups/{id}\" }`. - For a view: `{ \"ref\": \"/snapshots/{id}\" }` (the parent snapshot)."},"retention_policy":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"description":"Reference to the retention policy governing this snapshot. Shape: `{ \"ref\": \"/retention_policies/{id}\" }`."},"is_auto_deleteable":{"$ref":"#/components/schemas/Snapshots/properties/is_auto_deleteable"},"is_exposable":{"$ref":"#/components/schemas/Snapshots/properties/is_exposable"},"description_list":{"type":"string"},"is_application_consistent_list":{"type":"boolean"}},"required":["short_name","source","retention_policy"]}}}}}}}}
```

## GET /snapshots/{id}

> Get a snapshot

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Snapshots","description":"Snapshots are instant, point-in-time copies of a volume group. They don't initially consume additional capacity; Silk preserves only the data needed to maintain each point in time as the source changes.\n\nUse these endpoints to create a recovery point before a risky change, preserve data for development or testing, create writable copies, or manage snapshot retention and 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":{"Snapshots":{"type":"object","properties":{"creation_time":{"type":"number","description":"Unix timestamp the snapshot was taken."},"data_creation_time":{"type":"integer","nullable":true,"description":"Unix timestamp of the underlying data, distinct from when the metadata record was written."},"description":{"type":"string","nullable":true,"description":"Free-form description."},"generation_number":{"type":"integer","nullable":true,"description":"Per-source counter."},"id":{"type":"integer","description":"Unique identifier."},"is_application_consistent":{"type":"boolean","nullable":true,"description":"`true` when the snapshot was taken with application coordination."},"is_auto_deleteable":{"type":"boolean","description":"`true` if the SDP may auto-delete this record under retention policy."},"is_deleted":{"type":"boolean","description":"`true` once the SDP has marked the record for deletion (it may still be visible briefly)."},"is_exist_on_peer":{"type":"boolean","description":"`true` if the snapshot also exists on a replication peer."},"is_exposable":{"type":"boolean","description":"`true` for views (mappable like a volume), `false` for ordinary snapshots."},"is_external":{"type":"boolean","nullable":true,"description":"`true` if originated from outside the local SDP."},"is_originating_from_peer":{"type":"boolean","nullable":true,"description":"`true` if originated from a replication peer."},"iscsi_tgt_converted_name":{"type":"string","description":"Target name used for iSCSI exposure of an exposable view."},"last_exposed_time":{"type":"integer","nullable":true,"description":"Unix timestamp of the most recent exposure event (views only)."},"name":{"type":"string","description":"Full computed name (`{volume_group}:{short_name}`)."},"replication_session":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the replication session, when applicable."},"retention_policy":{"$ref":"#/components/schemas/Ref","description":"Reference to the retention policy governing this snapshot. Shape: `{ \"ref\": \"/retention_policies/{id}\" }`."},"short_name":{"type":"string","description":"The portion supplied at creation."},"source":{"$ref":"#/components/schemas/Ref","description":"What this snapshot was taken from. - For a snapshot: `{ \"ref\": \"/volume_groups/{id}\" }`. - For a view: `{ \"ref\": \"/snapshots/{id}\" }` (the parent snapshot)."},"triggered_by":{"type":"string","description":"Origin of the create action, e.g. `api`, `scheduler`, `replication`."},"volsnaps_provisioned_capacity":{"type":"integer","description":"Provisioned capacity attributed to the snapshot, in kilobytes."},"volume_group":{"$ref":"#/components/schemas/Ref","description":"Reference to the volume group the snapshot ultimately belongs to. Shape: `{ \"ref\": \"/volume_groups/{id}\" }`."},"wwn":{"type":"string","nullable":true,"description":"WWN assigned to the snapshot/view."}}},"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":{"/snapshots/{id}":{"get":{"tags":["Snapshots"],"summary":"Get a snapshot","operationId":"getSnapshots","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Snapshots"}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## DELETE /snapshots/{id}

> Delete a snapshot

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Snapshots","description":"Snapshots are instant, point-in-time copies of a volume group. They don't initially consume additional capacity; Silk preserves only the data needed to maintain each point in time as the source changes.\n\nUse these endpoints to create a recovery point before a risky change, preserve data for development or testing, create writable copies, or manage snapshot retention and 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":{"/snapshots/{id}":{"delete":{"tags":["Snapshots"],"summary":"Delete a snapshot","operationId":"deleteSnapshots","responses":{"204":{"description":"No content"},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## PATCH /snapshots/{id}

> Update a snapshot

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Snapshots","description":"Snapshots are instant, point-in-time copies of a volume group. They don't initially consume additional capacity; Silk preserves only the data needed to maintain each point in time as the source changes.\n\nUse these endpoints to create a recovery point before a risky change, preserve data for development or testing, create writable copies, or manage snapshot retention and 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":{"Snapshots":{"type":"object","properties":{"creation_time":{"type":"number","description":"Unix timestamp the snapshot was taken."},"data_creation_time":{"type":"integer","nullable":true,"description":"Unix timestamp of the underlying data, distinct from when the metadata record was written."},"description":{"type":"string","nullable":true,"description":"Free-form description."},"generation_number":{"type":"integer","nullable":true,"description":"Per-source counter."},"id":{"type":"integer","description":"Unique identifier."},"is_application_consistent":{"type":"boolean","nullable":true,"description":"`true` when the snapshot was taken with application coordination."},"is_auto_deleteable":{"type":"boolean","description":"`true` if the SDP may auto-delete this record under retention policy."},"is_deleted":{"type":"boolean","description":"`true` once the SDP has marked the record for deletion (it may still be visible briefly)."},"is_exist_on_peer":{"type":"boolean","description":"`true` if the snapshot also exists on a replication peer."},"is_exposable":{"type":"boolean","description":"`true` for views (mappable like a volume), `false` for ordinary snapshots."},"is_external":{"type":"boolean","nullable":true,"description":"`true` if originated from outside the local SDP."},"is_originating_from_peer":{"type":"boolean","nullable":true,"description":"`true` if originated from a replication peer."},"iscsi_tgt_converted_name":{"type":"string","description":"Target name used for iSCSI exposure of an exposable view."},"last_exposed_time":{"type":"integer","nullable":true,"description":"Unix timestamp of the most recent exposure event (views only)."},"name":{"type":"string","description":"Full computed name (`{volume_group}:{short_name}`)."},"replication_session":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"nullable":true,"description":"Reference to the replication session, when applicable."},"retention_policy":{"$ref":"#/components/schemas/Ref","description":"Reference to the retention policy governing this snapshot. Shape: `{ \"ref\": \"/retention_policies/{id}\" }`."},"short_name":{"type":"string","description":"The portion supplied at creation."},"source":{"$ref":"#/components/schemas/Ref","description":"What this snapshot was taken from. - For a snapshot: `{ \"ref\": \"/volume_groups/{id}\" }`. - For a view: `{ \"ref\": \"/snapshots/{id}\" }` (the parent snapshot)."},"triggered_by":{"type":"string","description":"Origin of the create action, e.g. `api`, `scheduler`, `replication`."},"volsnaps_provisioned_capacity":{"type":"integer","description":"Provisioned capacity attributed to the snapshot, in kilobytes."},"volume_group":{"$ref":"#/components/schemas/Ref","description":"Reference to the volume group the snapshot ultimately belongs to. Shape: `{ \"ref\": \"/volume_groups/{id}\" }`."},"wwn":{"type":"string","nullable":true,"description":"WWN assigned to the snapshot/view."}}},"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":{"/snapshots/{id}":{"patch":{"tags":["Snapshots"],"summary":"Update a snapshot","operationId":"updateSnapshots","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Update snapshot","properties":{"name":{"$ref":"#/components/schemas/Snapshots/properties/name"},"short_name":{"$ref":"#/components/schemas/Snapshots/properties/short_name"},"retention_policy":{"allOf":[{"$ref":"#/components/schemas/Ref"}],"description":"Reference to the retention policy governing this snapshot. Shape: `{ \"ref\": \"/retention_policies/{id}\" }`."},"is_auto_deleteable":{"$ref":"#/components/schemas/Snapshots/properties/is_auto_deleteable"},"is_application_consistent_list":{"type":"boolean"}}},{"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/Snapshots"}}}},"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/snapshots.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.
