REST Resource: projects.locations.backups
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Backup
A Backup of a Cloud Firestore Database.
The backup contains all documents and index configurations for the given database at a specific point in time.
| JSON representation |
{
"name": string,
"database": string,
"databaseUid": string,
"snapshotTime": string,
"expireTime": string,
"state": enum (State)
} |
| Fields |
name |
string
Output only. The unique resource name of the Backup. Format is projects/{project}/locations/{location}/backups/{backup}.
|
database |
string
Output only. Name of the Firestore database that the backup is from. Format is projects/{project}/databases/{database}.
|
databaseUid |
string
Output only. The system-generated UUID4 for the Firestore database that the backup is from.
|
snapshotTime |
string (Timestamp format)
Output only. The backup contains an externally consistent copy of the database at this time. 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".
|
expireTime |
string (Timestamp format)
Output only. The timestamp at which this backup expires. 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".
|
state |
enum (State)
Output only. The current state of the backup.
|
State
Indicate the current state of the backup.
| Enums |
STATE_UNSPECIFIED |
The state is unspecified. |
CREATING |
The pending backup is still being created. Operations on the backup will be rejected in this state. |
READY |
The backup is complete and ready to use. |
NOT_AVAILABLE |
The backup is not available at this moment. |
Methods |
|
|
Deletes a backup. |
|
|
Gets information about a backup. |
|
|
Lists all the backups. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-26 UTC.
[null,null,["Last updated 2025-08-26 UTC."],[],[],null,["# REST Resource: projects.locations.backups\n\nResource: Backup\n----------------\n\nA Backup of a Cloud Firestore Database.\n\nThe backup contains all documents and index configurations for the given database at a specific point in time.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"database\": string, \"databaseUid\": string, \"snapshotTime\": string, \"expireTime\": string, \"state\": enum (/docs/firestore/reference/rest/v1/projects.locations.backups#State) } ``` |\n\n| Fields ||\n|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. The unique resource name of the Backup. Format is `projects/{project}/locations/{location}/backups/{backup}`. |\n| `database` | `string` Output only. Name of the Firestore database that the backup is from. Format is `projects/{project}/databases/{database}`. |\n| `databaseUid` | `string` Output only. The system-generated UUID4 for the Firestore database that the backup is from. |\n| `snapshotTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Output only. The backup contains an externally consistent copy of the database at this time. Uses RFC 3339, where generated output will always be Z-normalized and uses 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\"`. |\n| `expireTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Output only. The timestamp at which this backup expires. Uses RFC 3339, where generated output will always be Z-normalized and uses 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\"`. |\n| `state` | `enum (`[State](/docs/firestore/reference/rest/v1/projects.locations.backups#State)`)` Output only. The current state of the backup. |\n\nState\n-----\n\nIndicate the current state of the backup.\n\n| Enums ||\n|---------------------|-----------------------------------------------------------------------------------------------------|\n| `STATE_UNSPECIFIED` | The state is unspecified. |\n| `CREATING` | The pending backup is still being created. Operations on the backup will be rejected in this state. |\n| `READY` | The backup is complete and ready to use. |\n| `NOT_AVAILABLE` | The backup is not available at this moment. |\n\n| Methods ------- ||\n|-----------------------------------------------------------------------------------|----------------------------------|\n| ### [delete](/docs/firestore/reference/rest/v1/projects.locations.backups/delete) | Deletes a backup. |\n| ### [get](/docs/firestore/reference/rest/v1/projects.locations.backups/get) | Gets information about a backup. |\n| ### [list](/docs/firestore/reference/rest/v1/projects.locations.backups/list) | Lists all the backups. |"]]
