# REST Resource: projects.locations.instances.snapshots

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

## Resource: Snapshot

A Filestore snapshot.

| JSON representation |
|---|
| ``` { "name": string, "description": string, "state": enum (`https://docs.cloud.google.com/filestore/docs/reference/rest/v1/projects.locations.instances.snapshots#State`), "createTime": string, "labels": { string: string, ... }, "filesystemUsedBytes": string, "tags": { string: string, ... } } ``` |

| Fields ||
|---|---|
| `name` | `string` Output only. The resource name of the snapshot, in the format `projects/{projectId}/locations/{locationId}/instances/{instanceId}/snapshots/{snapshotId}`. |
| `description` | `string` A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected. |
| `state` | ``enum (`https://docs.cloud.google.com/filestore/docs/reference/rest/v1/projects.locations.instances.snapshots#State`)`` Output only. The snapshot state. |
| `createTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The time when the snapshot was created. 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)` Resource labels to represent user provided metadata. An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. |
| `filesystemUsedBytes` | `string (https://developers.google.com/discovery/v1/type-format format)` Output only. The amount of bytes needed to allocate a full copy of the snapshot content |
| `tags` | `map (key: string, value: string)` Optional. Input only. Immutable. Tag key-value pairs bound to this resource. Each key must be a namespaced name and each value a short name. Example: "123456789012/environment" : "production", "123456789013/costCenter" : "marketing" See the documentation for more information: - Namespaced name: <https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key> - Short name: <https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value> An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. |

## State

The snapshot state.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | State not set. |
| `CREATING` | Snapshot is being created. |
| `READY` | Snapshot is available for use. |
| `DELETING` | Snapshot is being deleted. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/filestore/docs/reference/rest/v1/projects.locations.instances.snapshots/create` | Creates a snapshot. |
| ### `https://docs.cloud.google.com/filestore/docs/reference/rest/v1/projects.locations.instances.snapshots/delete` | Deletes a snapshot. |
| ### `https://docs.cloud.google.com/filestore/docs/reference/rest/v1/projects.locations.instances.snapshots/get` | Gets the details of a specific snapshot. |
| ### `https://docs.cloud.google.com/filestore/docs/reference/rest/v1/projects.locations.instances.snapshots/list` | Lists all snapshots in a project for either a specified location or for all locations. |
| ### `https://docs.cloud.google.com/filestore/docs/reference/rest/v1/projects.locations.instances.snapshots/patch` | Updates the settings of a specific snapshot. |