# REST Resource: projects.locations.backups

- [Resource: Backup](https://docs.cloud.google.com/filestore/docs/reference/rest/v1beta1/projects.locations.backups#Backup)
  - [JSON representation](https://docs.cloud.google.com/filestore/docs/reference/rest/v1beta1/projects.locations.backups#Backup.SCHEMA_REPRESENTATION)
- [State](https://docs.cloud.google.com/filestore/docs/reference/rest/v1beta1/projects.locations.backups#State)
- [Methods](https://docs.cloud.google.com/filestore/docs/reference/rest/v1beta1/projects.locations.backups#METHODS_SUMMARY)

## Resource: Backup

A Filestore backup.

| JSON representation |
|---|
| ``` { "name": string, "description": string, "state": enum (`https://docs.cloud.google.com/filestore/docs/reference/rest/v1beta1/projects.locations.backups#State`), "createTime": string, "labels": { string: string, ... }, "capacityGb": string, "storageBytes": string, "sourceInstance": string, "sourceFileShare": string, "sourceInstanceTier": enum (`https://docs.cloud.google.com/filestore/docs/reference/rest/v1beta1/Tier`), "downloadBytes": string, "satisfiesPzs": boolean, "satisfiesPzi": boolean, "kmsKeyName": string, "tags": { string: string, ... }, "fileSystemProtocol": enum (`https://docs.cloud.google.com/filestore/docs/reference/rest/v1beta1/FileProtocol`) } ``` |

| Fields ||
|---|---|
| `name` | `string` Output only. The resource name of the backup, in the format `projects/{projectId}/locations/{locationId}/backups/{backupId}`. |
| `description` | `string` A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. |
| `state` | ``enum (`https://docs.cloud.google.com/filestore/docs/reference/rest/v1beta1/projects.locations.backups#State`)`` Output only. The backup state. |
| `createTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The time when the backup 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" }`. |
| `capacityGb` | `string (https://developers.google.com/discovery/v1/type-format format)` Output only. Capacity of the source file share when the backup was created. |
| `storageBytes` | `string (https://developers.google.com/discovery/v1/type-format format)` Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion. |
| `sourceInstance` | `string` The resource name of the source Filestore instance, in the format `projects/{projectId}/locations/{locationId}/instances/{instanceId}`, used to create this backup. |
| `sourceFileShare` | `string` Name of the file share in the source Filestore instance that the backup is created from. |
| `sourceInstanceTier` | ``enum (`https://docs.cloud.google.com/filestore/docs/reference/rest/v1beta1/Tier`)`` Output only. The service tier of the source Filestore instance that this backup is created from. |
| `downloadBytes` | `string (https://developers.google.com/discovery/v1/type-format format)` Output only. Amount of bytes that will be downloaded if the backup is restored |
| `satisfiesPzs` | `boolean` Output only. Reserved for future use. |
| `satisfiesPzi` | `boolean` Output only. Reserved for future use. |
| `kmsKeyName` | `string` Immutable. KMS key name used for data encryption. |
| `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" }`. |
| `fileSystemProtocol` | ``enum (`https://docs.cloud.google.com/filestore/docs/reference/rest/v1beta1/FileProtocol`)`` Output only. The file system protocol of the source Filestore instance that this backup is created from. |

## State

The backup state.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | State not set. |
| `CREATING` | Backup is being created. |
| `FINALIZING` | Backup has been taken and the operation is being finalized. At this point, changes to the file share will not be reflected in the backup. |
| `READY` | Backup is available for use. |
| `DELETING` | Backup is being deleted. |
| `INVALID` | Backup is not valid and cannot be used for creating new instances or restoring existing instances. |

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