Stay organized with collections
Save and categorize content based on your preferences.
Resource: BackupSchedule
A backup schedule for a Cloud Firestore Database.
This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though.
JSON representation
{"name": string,"createTime": string,"updateTime": string,"retention": string,// Union field recurrence can be only one of the following:"dailyRecurrence": {object (DailyRecurrence)},"weeklyRecurrence": {object (WeeklyRecurrence)}// End of list of possible types for union field recurrence.}
Fields
name
string
Output only. The unique backup schedule identifier across all locations and databases for the given project.
This will be auto-assigned.
Format is projects/{project}/databases/{database}/backupSchedules/{backupSchedule}
Output only. The timestamp at which this backup schedule was created and effective since.
No backups will be created for this schedule before 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".
Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as createTime.
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".
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-26 UTC."],[],[],null,["# REST Resource: projects.databases.backupSchedules\n\nResource: BackupSchedule\n------------------------\n\nA backup schedule for a Cloud Firestore Database.\n\nThis resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"createTime\": string, \"updateTime\": string, \"retention\": string, // Union field `recurrence` can be only one of the following: \"dailyRecurrence\": { object (/docs/firestore/reference/rest/v1/projects.databases.backupSchedules#DailyRecurrence) }, \"weeklyRecurrence\": { object (/docs/firestore/reference/rest/v1/projects.databases.backupSchedules#WeeklyRecurrence) } // End of list of possible types for union field `recurrence`. } ``` |\n\n| Fields ||\n|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backupSchedule}` |\n| `createTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before 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| `updateTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as createTime. 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| `retention` | `string (`[Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration)` format)` At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks. A duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `\"3.5s\"`. |\n| Union field `recurrence`. A oneof field to represent when backups will be taken. `recurrence` can be only one of the following: ||\n| `dailyRecurrence` | `object (`[DailyRecurrence](/docs/firestore/reference/rest/v1/projects.databases.backupSchedules#DailyRecurrence)`)` For a schedule that runs daily. |\n| `weeklyRecurrence` | `object (`[WeeklyRecurrence](/docs/firestore/reference/rest/v1/projects.databases.backupSchedules#WeeklyRecurrence)`)` For a schedule that runs weekly on a specific day. |\n\nDailyRecurrence\n---------------\n\nThis type has no fields.\nRepresents a recurring schedule that runs every day.\n\nThe time zone is UTC.\n\nWeeklyRecurrence\n----------------\n\nRepresents a recurring schedule that runs on a specified day of the week.\n\nThe time zone is UTC.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------|\n| ``` { \"day\": enum (/docs/firestore/reference/rest/v1/projects.databases.backupSchedules#DayOfWeek) } ``` |\n\n| Fields ||\n|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `day` | `enum (`[DayOfWeek](/docs/firestore/reference/rest/v1/projects.databases.backupSchedules#DayOfWeek)`)` The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. |\n\nDayOfWeek\n---------\n\nRepresents a day of the week.\n\n| Enums ||\n|---------------------------|-------------------------------------|\n| `DAY_OF_WEEK_UNSPECIFIED` | The day of the week is unspecified. |\n| `MONDAY` | Monday |\n| `TUESDAY` | Tuesday |\n| `WEDNESDAY` | Wednesday |\n| `THURSDAY` | Thursday |\n| `FRIDAY` | Friday |\n| `SATURDAY` | Saturday |\n| `SUNDAY` | Sunday |\n\n| Methods ------- ||\n|-------------------------------------------------------------------------------------------|-------------------------------------------|\n| ### [create](/docs/firestore/reference/rest/v1/projects.databases.backupSchedules/create) | Creates a backup schedule on a database. |\n| ### [delete](/docs/firestore/reference/rest/v1/projects.databases.backupSchedules/delete) | Deletes a backup schedule. |\n| ### [get](/docs/firestore/reference/rest/v1/projects.databases.backupSchedules/get) | Gets information about a backup schedule. |\n| ### [list](/docs/firestore/reference/rest/v1/projects.databases.backupSchedules/list) | List backup schedules. |\n| ### [patch](/docs/firestore/reference/rest/v1/projects.databases.backupSchedules/patch) | Updates a backup schedule. |"]]
