---
title: "POST /v1/{+parent}/backupPlans"
method: POST
path: "/v1/{+parent}/backupPlans"
tags: ["projects"]
---

# POST /v1/{+parent}/backupPlans

`POST /v1/{+parent}/backupPlans`

Creates a new BackupPlan in a given location.

## Path parameters

- `parent` string, required

## Query parameters

- `backupPlanId` string

## Request body

- BackupPlan — Defines the configuration and scheduling for a "line" of Backups.
  - `description` string — Optional. User specified descriptive string for this BackupPlan.
  - `backupConfig` BackupConfig — BackupConfig defines the configuration of Backups created via this BackupPlan.
    - `selectedNamespaces` Namespaces — A list of Kubernetes Namespaces.
      - `namespaces` string[] — Optional. A list of Kubernetes Namespaces.
    - `allNamespaces` boolean — If True, include all namespaced resources
    - `permissiveMode` boolean — Optional. If false, Backups will fail when Backup for GKE detects Kubernetes configuration that is non-standard or requires additional setup to restore. Default: False
    - `encryptionKey` EncryptionKey — Defined a customer managed encryption key that will be used to encrypt Backup artifacts.
      - `gcpKmsEncryptionKey` string — Optional. Google Cloud KMS encryption key. Format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`
    - `includeSecrets` boolean — Optional. This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False
    - `selectedApplications` NamespacedNames — A list of namespaced Kubernetes resources.
      - `namespacedNames` NamespacedName[] — Optional. A list of namespaced Kubernetes resources.
        - `name` string — Optional. The name of the Kubernetes resource.
        - `namespace` string — Optional. The Namespace of the Kubernetes resource.
    - `selectedNamespaceLabels` ResourceLabels — A list of Kubernetes labels.
      - `resourceLabels` Label[] — Optional. A list of Kubernetes label-value pairs.
        - `key` string — Optional. The key/name of the label.
        - `value` string — Optional. The value of the label.
    - `includeVolumeData` boolean — Optional. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False
  - `cluster` string — Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*`
  - `etag` string — Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackupPlan`, and systems are expected to put that etag in the request to `UpdateBackupPlan` or `DeleteBackupPlan` to ensure that their change will be applied to the same version of the resource.
  - `updateTime` string, google-datetime — Output only. The timestamp when this BackupPlan resource was last updated.
  - `backupChannel` string — Output only. The fully qualified name of the BackupChannel to be used to create a backup. This field is set only if the cluster being backed up is in a different project. `projects/*/locations/*/backupChannels/*`
  - `backupSchedule` Schedule — Defines scheduling parameters for automatically creating Backups via this BackupPlan.
    - `cronSchedule` string — Optional. A standard [cron](https://wikipedia.com/wiki/cron) string that defines a repeating schedule for creating Backups via this BackupPlan. This is mutually exclusive with the rpo_config field since at most one schedule can be defined for a BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.
    - `rpoConfig` RpoConfig — Defines RPO scheduling configuration for automatically creating Backups via this BackupPlan.
      - `targetRpoMinutes` integer — Required. Defines the target RPO for the BackupPlan in minutes, which means the target maximum data loss in time that is acceptable for this BackupPlan. This must be at least 60, i.e., 1 hour, and at most 86400, i.e., 60 days.
      - `exclusionWindows` ExclusionWindow[] — Optional. User specified time windows during which backup can NOT happen for this BackupPlan - backups should start and finish outside of any given exclusion window. Note: backup jobs will be scheduled to start and finish outside the duration of the window as much as possible, but running jobs will not get canceled when it runs into the window. All the time and date values in exclusion_windows entry in the API are in UTC. We only allow <=1 recurrence (daily or weekly) exclusion window for a BackupPlan while no restriction on number of single occurrence windows.
        - `duration` string, google-duration — Required. Specifies duration of the window. Duration must be >= 5 minutes and < (target RPO - 20 minutes). Additional restrictions based on the recurrence type to allow some time for backup to happen: - single_occurrence_date: no restriction, but UI may warn about this when duration >= target RPO - daily window: duration < 24 hours - weekly window: - days of week includes all seven days of a week: duration < 24 hours - all other weekly window: duration < 168 hours (i.e., 24 * 7 hours)
        - `startTime` TimeOfDay — Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.
          - `hours` integer — Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
          - `minutes` integer — Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
          - `nanos` integer — Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
          - `seconds` integer — Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
        - `singleOccurrenceDate` Date — Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
          - `year` integer — Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
          - `month` integer — Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
          - `day` integer — Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
        - `daysOfWeek` DayOfWeekList — Holds repeated DaysOfWeek values as a container.
          - `daysOfWeek` string[] — Optional. A list of days of week.
        - `daily` boolean — The exclusion window occurs every day if set to "True". Specifying this field to "False" is an error.
    - `paused` boolean — Optional. This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False
    - `nextScheduledBackupTime` string, google-datetime — Output only. Start time of next scheduled backup under this BackupPlan by either cron_schedule or rpo config.
  - `protectedPodCount` integer — Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
  - `stateReason` string — Output only. Human-readable description of why BackupPlan is in the current `state`. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.
  - `uid` string — Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
  - `lastSuccessfulBackupTime` string, google-datetime — Output only. Completion time of the last successful Backup. This is sourced from a successful Backup's complete_time field. This field is added to maintain consistency with BackupPlanBinding to display last successful backup time.
  - `labels` object — Optional. A set of custom labels supplied by user.
  - `deactivated` boolean — Optional. This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False
  - `protectedNamespaceCount` integer — Output only. The number of user managed namespaces backed up in the last successful Backup created via this BackupPlan.
  - `rpoRiskReason` string — Output only. Human-readable description of why the BackupPlan is in the current rpo_risk_level and action items if any.
  - `retentionPolicy` RetentionPolicy — RetentionPolicy defines a Backup retention policy for a BackupPlan.
    - `locked` boolean — Optional. This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the `locked` field itself. Default: False
    - `backupDeleteLockDays` integer — Optional. Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)
    - `backupRetainDays` integer — Optional. The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backup_retain_days must be >= backup_delete_lock_days. If cron_schedule is defined, then this must be <= 360 * the creation interval. If rpo_config is defined, then this must be <= 360 * target_rpo_minutes / (1440minutes/day). Default: 0 (no automatic deletion)
  - `state` 'STATE_UNSPECIFIED' | 'CLUSTER_PENDING' | 'PROVISIONING' | 'READY' | 'FAILED' | 'DEACTIVATED' | 'DELETING' — Output only. State of the BackupPlan. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update
  - `rpoRiskLevel` integer — Output only. A number that represents the current risk level of this BackupPlan from RPO perspective with 1 being no risk and 5 being highest risk.
  - `name` string — Output only. Identifier. The full name of the BackupPlan resource. Format: `projects/*/locations/*/backupPlans/*`
  - `createTime` string, google-datetime — Output only. The timestamp when this BackupPlan resource was created.

## Response `200`

Successful response

---

[API](https://skmtc.dev/google/apis/gkebackup.md) · [All operations](https://skmtc.dev/google/apis/gkebackup/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/google/gkebackup/revisions/b07f418446fd/schema)