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

# POST /v1/{+name}:backup

`POST /v1/{+name}:backup`

Backup Redis Cluster. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the cluster's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.

## Path parameters

- `name` string, required

## Request body

- BackupClusterRequest — Request for `BackupCluster`.
  - `ttl` string, google-duration — Optional. TTL for the backup to expire. Value range is 1 day to 100 years. If not specified, the default value is 100 years.
  - `backupId` string — Optional. The id of the backup to be created. If not specified, the default value ([YYYYMMDDHHMMSS]_[Shortened Cluster UID] is used.

## Response `200`

Successful response

---

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