# REST Resource: projects.locations.volumes.snapshots

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

## Resource: Snapshot

Snapshot is a point-in-time version of a Volume's content.

| JSON representation |
|---|
| ``` { "name": string, "state": enum (`https://docs.cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.volumes.snapshots#State`), "stateDetails": string, "description": string, "usedBytes": number, "createTime": string, "labels": { string: string, ... } } ``` |

| Fields ||
|---|---|
| `name` | `string` Identifier. The resource name of the snapshot. Format: `projects/{projectId}/locations/{location}/volumes/{volumeId}/snapshots/{snapshotId}`. |
| `state` | ``enum (`https://docs.cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.volumes.snapshots#State`)`` Output only. The snapshot state. |
| `stateDetails` | `string` Output only. State details of the storage pool |
| `description` | `string` A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected. |
| `usedBytes` | `number` Output only. Current storage usage for the snapshot in bytes. |
| `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" }`. |

## State

The Snapshot States

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Unspecified Snapshot State |
| `READY` | Snapshot State is Ready |
| `CREATING` | Snapshot State is Creating |
| `DELETING` | Snapshot State is Deleting |
| `UPDATING` | Snapshot State is Updating |
| `DISABLED` | Snapshot State is Disabled |
| `ERROR` | Snapshot State is Error |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.volumes.snapshots/create` | Create a new snapshot for a volume. |
| ### `https://docs.cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.volumes.snapshots/delete` | Deletes a snapshot. |
| ### `https://docs.cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.volumes.snapshots/get` | Describe a snapshot for a volume. |
| ### `https://docs.cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.volumes.snapshots/list` | Returns descriptions of all snapshots for a volume. |
| ### `https://docs.cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.volumes.snapshots/patch` | Updates the settings of a specific snapshot. |