Sign in

v1

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

Create a BackupPlan

post/v1/{+parent}/backupPlans

Path parameters

parentstring required

Required. The BackupPlan project and location in the format projects/{project}/locations/{location}. In Google Cloud Backup and DR locations map to Google Cloud regions, for example us-central1.

Query parameters

backupPlanIdstring

Required. The name of the BackupPlan to create. The name must be unique for the specified project and location.The name must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.

requestIdstring

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

createTimestring google-datetime

Output only. When the BackupPlan was created.

revisionIdstring

Output only. The user friendly revision ID of the BackupPlanRevision. Example: v0, v1, v2, etc.

revisionNamestring

Output only. The resource id of the BackupPlanRevision. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}

updateTimestring google-datetime

Output only. When the BackupPlan was last updated.

namestring

Output only. Identifier. The resource name of the BackupPlan. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}

state'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'DELETING' | 'INACTIVE' | 'UPDATING'

Output only. The State for the BackupPlan.

resourceTypestring

Required. The resource type to which the BackupPlan will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance", "alloydb.googleapis.com/Cluster", "compute.googleapis.com/Disk".

descriptionstring

Optional. The description of the BackupPlan resource. The description allows for additional details about BackupPlan and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters.

labelsobject

Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.

backupVaultServiceAccountstring

Output only. The Google Cloud service account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account.

backupVaultstring

Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}

etagstring

Optional. etag is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources.

supportedResourceTypesstring[]

Output only. All resource types to which backupPlan can be applied.

logRetentionDaysstring int64

Optional. Applicable only for Cloud SQL resource_type. Configures how long logs will be stored. It is defined in “days”. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.

maxCustomOnDemandRetentionDaysinteger

Optional. Optional field to configure the maximum number of days for which a backup can be retained. This field is only applicable for on-demand backups taken with custom retention value.

Response

Successful response