# REST Resource: projects.snapshots

- [Resource: Snapshot](https://docs.cloud.google.com/pubsub/docs/reference/rest/v1/projects.snapshots#Snapshot)
  - [JSON representation](https://docs.cloud.google.com/pubsub/docs/reference/rest/v1/projects.snapshots#Snapshot.SCHEMA_REPRESENTATION)
- [Methods](https://docs.cloud.google.com/pubsub/docs/reference/rest/v1/projects.snapshots#METHODS_SUMMARY)

## Resource: Snapshot

A snapshot resource. Snapshots are used in [subscriptions.seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

| JSON representation |
|---|
| ``` { "name": string, "topic": string, "expireTime": string, "labels": { string: string, ... } } ``` |

| Fields ||
|---|---|
| `name` | `string` Optional. The name of the snapshot. |
| `topic` | `string` Optional. The name of the topic from which this snapshot is retaining messages. |
| `expireTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Optional. The snapshot is guaranteed to exist up until this time. A newly-created snapshot expires no later than 7 days from the time of its creation. Its exact lifetime is determined at creation by the existing backlog in the source subscription. Specifically, the lifetime of the snapshot is `7 days - (age of oldest unacked message in the subscription)`. For example, consider a subscription whose oldest unacked message is 3 days old. If a snapshot is created from this subscription, the snapshot -- which will always capture this 3-day-old backlog as long as the snapshot exists -- will expire in 4 days. The service will refuse to create a snapshot that would expire in less than 1 hour after creation. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `labels` | `map (key: string, value: string)` Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels). An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/pubsub/docs/reference/rest/v1/projects.snapshots/create` | Creates a snapshot from the requested subscription. |
| ### `https://docs.cloud.google.com/pubsub/docs/reference/rest/v1/projects.snapshots/delete` | Removes an existing snapshot. |
| ### `https://docs.cloud.google.com/pubsub/docs/reference/rest/v1/projects.snapshots/get` | Gets the configuration details of a snapshot. |
| ### `https://docs.cloud.google.com/pubsub/docs/reference/rest/v1/projects.snapshots/getIamPolicy` | Gets the access control policy for a resource. |
| ### `https://docs.cloud.google.com/pubsub/docs/reference/rest/v1/projects.snapshots/list` | Lists the existing snapshots. |
| ### `https://docs.cloud.google.com/pubsub/docs/reference/rest/v1/projects.snapshots/patch` | Updates an existing snapshot by updating the fields specified in the update mask. |
| ### `https://docs.cloud.google.com/pubsub/docs/reference/rest/v1/projects.snapshots/setIamPolicy` | Sets the access control policy on the specified resource. |
| ### `https://docs.cloud.google.com/pubsub/docs/reference/rest/v1/projects.snapshots/testIamPermissions` | Returns permissions that a caller has on the specified resource. |