v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1338139174.7 KB
projects

Creates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule and one weekly backup schedule.

post/v1/{+parent}/backupSchedules

Path parameters

parentstring required

Required. The parent database. Format projects/{project}/databases/{database}

Request body

dailyRecurrenceGoogleFirestoreAdminV1DailyRecurrence

Represents a recurring schedule that runs every day. The time zone is UTC.

updateTimestring google-datetime

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 create_time.

createTimestring google-datetime

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.

namestring

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/{backup_schedule}

retentionstring google-duration

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.

Response

Successful response