gcloud alpha container backup-restore backups create Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud alpha container backup-restore backups create - creates a backup
- SYNOPSIS
gcloud alpha container backup-restore backups create(BACKUP:--backup-plan=BACKUP_PLAN--location=LOCATION)[--delete-lock-days=DELETE_LOCK_DAYS][--description=DESCRIPTION][--labels=[KEY=VALUE,…]][--retain-days=RETAIN_DAYS][--async|--wait-for-completion][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(ALPHA)Creates a Backup for GKE backup.- EXAMPLES
- To create a backup
in projectmy-backupin locationmy-projectunder backup planus-central1, run:my-backup-plangcloudalphacontainerbackup-restorebackupscreatemy-backup--project=my-project--location=us-central1--backup-plan=my-backup-planTo create a backup
in projectmy-backupin locationmy-projectunder backup planus-central1and not wait for theresulting operation to finish, run:my-backup-plangcloudalphacontainerbackup-restorebackupscreatemy-backup--project=my-project--location=us-central1--backup-plan=my-backup-plan--asyncTo create a backup
in projectmy-backupin locationmy-projectunder backup planus-central1and wait for the Backupmy-backup-plantocomplete,run:
gcloudalphacontainerbackup-restorebackupscreatemy-backup--project=my-project--location=us-central1--backup-plan=my-backup-plan--wait-for-completion - POSITIONAL ARGUMENTS
- Backup resource - Name of the backup to create. Once the backup is created, thisname can't be changed. This must be 63 or fewer characters long and must beunique within the project, location, and backup plan. The name may be providedeither as a relative name, e.g.
projects/<project>/locations/<location>/backupPlans/<backupPlan>/backups/<backup>or as a single ID name (with the parent resources provided via options orthrough properties), e.g.BACKUP --project=<project>--location=<location> --backup_plan=<backupPlan>. Thearguments in this group can be used to specify the attributes of this resource.(NOTE) Some attributes are not given arguments in this group but can be set inother ways.To set the
projectattribute:- provide the argument
backupon the command line with a fullyspecified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
BACKUP- ID of the backup or fully qualified identifier for the backup.
To set the
nameattribute:- provide the argument
backupon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--backup-plan=BACKUP_PLAN- Backup Plan name.
To set the
backup-planattribute:- provide the argument
backupon the command line with a fullyspecified name; - provide the argument
--backup-planon the command line; - set the property
gkebackup/backup_plan.
- provide the argument
--location=LOCATION- Google Cloud location.
To set the
locationattribute:- provide the argument
backupon the command line with a fullyspecified name; - provide the argument
--locationon the command line; - set the property
gkebackup/location.
- provide the argument
- provide the argument
- Backup resource - Name of the backup to create. Once the backup is created, thisname can't be changed. This must be 63 or fewer characters long and must beunique within the project, location, and backup plan. The name may be providedeither as a relative name, e.g.
- FLAGS
--delete-lock-days=DELETE_LOCK_DAYS- Delete lock days specifies the number of days from the createTime of this Backupbefore which deletion will be blocked. Must be >= the value in the backupplan. If not specified, inherited from the backup plan. Manual creation of abackup with this field unspecified causes the service to use the value ofbackupPlan.RetentionPolicy.backupDeleteBlockDays. Creation of a backup with thisfield set to a value SMALLER thanbackupPlan.RetentionPolicy.backupDeleteBlockDays results in an invalid responsefrom the service. This field MUST be an int value between 0-90(inclusive). Thisfield may only be INCREASED in an update command, or an invalid response will bereturned by the service.
--description=DESCRIPTION- Optional text description for the backup being created.
--labels=[KEY=VALUE,…]- List of label KEY=VALUE pairs to add.
Keys must start with a lowercase character and contain only hyphens(
-), underscores (_), lowercase characters, andnumbers. Values must contain only hyphens (-), underscores(_), lowercase characters, and numbers. --retain-days=RETAIN_DAYS- Retain days specifies the desired number of days from the createTime of thisbackup after which it will be automatically deleted. If not specified or set to0, it means the backup will NOT be automatically deleted. Manual creation of abackup with this field unspecified causes the service to use the value ofbackupPlan.retentionPolicy.backupRetainDays. Creation of a Backup with thisfield set to a value SMALLER than delete_lock_days results in an invalidresponse from the service. This field may ONLY be increased in an Updaterequest, or an invalid response will be returned by the service immediately.Default to 0 if not provided.
- At most one of these can be specified:
--async- Return immediately, without waiting for the operation in progress to complete.
--wait-for-completion- Wait for the created backup to complete.
- GCLOUD WIDE FLAGS
- These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$gcloud helpfor details. - NOTES
- This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. This variant is also available:
gcloudbetacontainerbackup-restorebackupscreate
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-22 UTC.